Add License

64bites · Oct 14, 2015 · 3506169 · 3506169
1 parent 81fb786
commit 3506169
Show file tree

Hide file tree

Showing 9 changed files with 151 additions and 0 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Michał Taszycki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.markdown b/README.markdown
@@ -0,0 +1,85 @@
+# 64spec
+
+6502/Commodore64 Testing Framework for KickAssembler
+
+## Installation
+
+### Recommended way
+
+1. Create a dir for libraries that your KickAssembler projects use.
+2. Get the current version of the 64spec.asm file and put it in this dir along with other libraries. 
+3. Import it in your spec files as <code>.import source "64spec.asm"</code>
+4. Make sure to pass option <code>-libdir <path-to-your-libraries-dir></code> when compiling with KickAssembler.
+
+### If you just want to try it out
+
+1. Get the current version of the 64spec.asm file and put it in the same directory as your spec files.
+2. Import it in your spec files as <code>.import source "64spec.asm"</code>
+
+## Quick Start
+
+#### 1. Create file example_spec.asm
+
+``` asm
+.import source "64spec.asm"
+
+sfspec: :init_spec()
+  
+  // TODO: Add assertions here
+
+  :finish_spec()
+```
+
+![Empty Spec](docs/qs01-empty.png?raw=true "Empty Spec")
+
+#### 2. Add first failing assertion.
+
+``` asm
+.import source "64spec.asm"
+
+sfspec: :init_spec()
+  
+  :assert_a_equal #42
+
+  :finish_spec()
+```
+
+![Empty Spec](docs/qs02-fail.png?raw=true "Empty Spec")
+
+3. Make it pass
+
+``` asm
+.import source "64spec.asm"
+
+sfspec: :init_spec()
+
+  lda #42
+  :assert_a_equal #42
+  
+  :finish_spec()
+```
+
+![Empty Spec](docs/qs03-pass.png?raw=true "Empty Spec")
+
+## License
+The MIT License (MIT)
+
+Copyright (c) 2015 Michał Taszycki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/docs/qs01-empty.png b/docs/qs01-empty.png
diff --git a/docs/qs02-fail.png b/docs/qs02-fail.png
diff --git a/docs/qs03-pass.png b/docs/qs03-pass.png
diff --git a/examples/qs01-empty_spec.asm b/examples/qs01-empty_spec.asm
@@ -0,0 +1,7 @@
+.import source "64spec.asm"
+
+sfspec: :init_spec()
+  
+  // TODO: Add assertions here
+
+  :finish_spec()
diff --git a/examples/qs02-failing_spec.asm b/examples/qs02-failing_spec.asm
@@ -0,0 +1,7 @@
+.import source "64spec.asm"
+
+sfspec: :init_spec()
+  
+  :assert_a_equal #42
+
+  :finish_spec()
diff --git a/examples/qs03-passing_spec.asm b/examples/qs03-passing_spec.asm
@@ -0,0 +1,8 @@
+.import source "64spec.asm"
+
+sfspec: :init_spec()
+
+  lda #42
+  :assert_a_equal #42
+  
+  :finish_spec()
diff --git a/lib/64spec.asm b/lib/64spec.asm
@@ -1,4 +1,27 @@
 .importonce
+
+// The MIT License (MIT)
+// 
+// Copyright (c) 2015 Michał Taszycki
+// 
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+// 
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+// 
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
 .const _64SPEC_VERSION_MAJOR = 0
 .const _64SPEC_VERSION_MINOR = 5
 .const _64SPEC_VERSION_PATCH = 0