Compare commits

...

2 Commits
0.0.2 ... 0.0.3

Author SHA1 Message Date
893badbada Amended README.md locally 2024-11-14 16:18:39 +01:00
df698554c0 Adjusted the readme and renamed some bits in sinqController. 2024-11-14 16:14:07 +01:00

View File

@ -16,6 +16,7 @@ sinqMotor offers a variety of additional methods for children classes to standar
### sinqAxis ### sinqAxis
- `atFirstPoll`: This function is executed once before the first poll. If it returns anything but `asynSuccess`, it retries. - `atFirstPoll`: This function is executed once before the first poll. If it returns anything but `asynSuccess`, it retries.
- `poll`: This is a wrapper around `doPoll` which performs some bookkeeping tasks before and after calling `doPoll`: - `poll`: This is a wrapper around `doPoll` which performs some bookkeeping tasks before and after calling `doPoll`:
Before calling `doPoll`: Before calling `doPoll`:
- Try to execute `atFirstPoll` once (and retry, if that failed) - Try to execute `atFirstPoll` once (and retry, if that failed)
@ -29,7 +30,7 @@ sinqMotor offers a variety of additional methods for children classes to standar
The versioning is done via git tags. Git tags are recognized by the PSI build system: If you tag a version as 1.0, it will be built into the directory /ioc/modules/sinqMotor/1.0. The tag is directly coupled to a commit so that it is always clear which source code was used to build which binary. The versioning is done via git tags. Git tags are recognized by the PSI build system: If you tag a version as 1.0, it will be built into the directory /ioc/modules/sinqMotor/1.0. The tag is directly coupled to a commit so that it is always clear which source code was used to build which binary.
All existing tags can be listed with `git tag` in the sinqMotor directory. Detailed information (author, data, commit number, commit message) regarding a specific tag can be shown with `git show X.X`, where X.X is the name of your version. To create a new tag, use `git tag -a X.X`. All existing tags can be listed with `git tag` in the sinqMotor directory. Detailed information (author, data, commit number, commit message) regarding a specific tag can be shown with `git show X.X`, where X.X is the name of your version. To create a new tag, use `git tag -a X.X`. If the tag `X.X` is already used by another commit, git will show a corresponding error.
## How to build it ## How to build it