Skip to content

Commit 6714b97

Browse files
committed
Updated readme
1 parent 99f5a9e commit 6714b97

1 file changed

Lines changed: 30 additions & 21 deletions

File tree

README.markdown renamed to README.md

Lines changed: 30 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,77 @@
1-
# 128spec
1+
# 128spec - 8502/Commodore128 Testing Framework for KickAssembler
22

3-
6502/Commodore128 Testing Framework for KickAssembler
3+
## Installation
44

5-
## Video introduction
5+
### Gradle way
66

7-
[![Video](docs/022.png?raw=true)](http://64bites.com/episodes/022-tdd-with-128spec/)
8-
## Installation
7+
Edit your <code>build.gradle</code> file and add a <code>libFromGitHub</code> to specify 128spec dependency.
8+
Be sure to add also a <code>viceExecutable = 'x128.exe'</code> because retro-assembler plugin default emulator is c64.
9+
10+
```gradle
11+
retroProject {
12+
viceExecutable = 'x128.exe'
13+
14+
libFromGitHub "c128lib/128spec", "0.7.2"
15+
}
16+
```
917

10-
### Recommended way
18+
### Other way
1119

1220
1. Create a dir for libraries that your KickAssembler projects use.
1321
2. Get the current version of the 128spec.asm file and put it in this dir along with other libraries.
14-
3. Import it in your spec files as <code>.import source "128spec.asm"</code>
22+
3. Import it in your spec files as <code>#import "128spec.asm"</code>
1523
4. Make sure to pass option <code>-libdir <path-to-your-libraries-dir></code> when compiling with KickAssembler.
1624

1725
### If you just want to try it out
1826

1927
1. Get the current version of the 128spec.asm file and put it in the same directory as your spec files.
20-
2. Import it in your spec files as <code>.import source "128spec.asm"</code>
28+
2. Import it in your spec files as <code>#import "128spec.asm"</code>
2129

2230
## Quick Start
2331

2432
#### 1. Create file example_spec.asm
2533

2634
``` asm
27-
.import source "128spec.asm"
35+
#import "128spec.asm"
2836
29-
sfspec: :init_spec()
37+
sfspec: init_spec()
3038
3139
// TODO: Add assertions here
3240
33-
:finish_spec()
41+
finish_spec()
3442
```
3543

3644
![Empty Spec](docs/qs01-empty.png?raw=true "Empty Spec")
3745

3846
#### 2. Add first failing assertion.
3947

4048
``` asm
41-
.import source "128spec.asm"
49+
#import "128spec.asm"
4250
43-
sfspec: :init_spec()
51+
sfspec: init_spec()
4452
45-
:assert_a_equal #42
53+
lda #0
54+
assert_a_equal #42
4655
47-
:finish_spec()
56+
finish_spec()
4857
```
4958

50-
![Empty Spec](docs/qs02-fail.png?raw=true "Empty Spec")
59+
![Empty Spec](docs/qs02-fail.png?raw=true "Test failed")
5160

5261
#### 3. Make it pass
5362

5463
``` asm
55-
.import source "128spec.asm"
64+
#import "128spec.asm"
5665
57-
sfspec: :init_spec()
66+
sfspec: init_spec()
5867
5968
lda #42
60-
:assert_a_equal #42
69+
assert_a_equal #42
6170
62-
:finish_spec()
71+
finish_spec()
6372
```
6473

65-
![Empty Spec](docs/qs03-pass.png?raw=true "Empty Spec")
74+
![Empty Spec](docs/qs03-pass.png?raw=true "Test passed")
6675

6776
## License
6877
The MIT License (MIT)

0 commit comments

Comments
 (0)