Skip to content

Commit 89e23c6

Browse files
committed
Update README for generating releases
1 parent f6a2130 commit 89e23c6

File tree

2 files changed

+19
-5
lines changed

2 files changed

+19
-5
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,20 @@ $ make clean
1515
$ make release
1616
```
1717

18+
## Releasing a new version of the library
19+
20+
This can be done with the gitlab automated workflow.
21+
To trigger it, tag the release with a version and push the tag to the remote.
22+
23+
Note, for the following to work, you must have a git remote named "upstream" pointing to
24+
the gitlab repository, and have permissions to push tags.
25+
26+
```shell
27+
git tag vX.Y.Z
28+
git push upstream vX.Y.Z
29+
```
30+
1831
## Testing
1932

20-
Testing is done with BDD features. See [Testing README](testing/bdd-testing/README.md)
33+
Testing is WIP.
34+
See [Testing README](testing/unit/README.md)

testing/unit/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# running unit tests
22

3-
Unit tests are a work in progress and use the soft65c02 project with extensions.
4-
5-
The repo for installing the unit test framework is https://github.com/markjfisher/soft65c02/tree/soft65c02_unit
6-
3+
Unit tests are a work in progress and use the soft65c02 project.
74

5+
The repo for installing the unit test framework is https://github.com/chanmix51/soft65c02
6+
You will need rust, and to follow the installation instructions for soft65c02.
7+
When installed, you will have 2 executables on the path; soft65c02_unit, soft65c02_tester.
88

99
## running individual tests
1010

0 commit comments

Comments
 (0)