mirror of
https://github.com/louisrubet/rpn
synced 2025-01-30 20:34:30 +01:00
#202: added METHODS.md
This commit is contained in:
parent
75ac3849af
commit
f2173c0470
2 changed files with 30 additions and 3 deletions
23
METHODS.md
Normal file
23
METHODS.md
Normal file
|
@ -0,0 +1,23 @@
|
|||
# Development methods
|
||||
|
||||
## Versioning
|
||||
|
||||
The software version number conforms to [SemVer semantic 2.0.0](https://semver.org/), aka `v<MAJOR>.<MINOR>.<PATCH>`
|
||||
|
||||
Suffixes `alpha` or `beta` are not used
|
||||
|
||||
## Workflow
|
||||
|
||||
This project conforms to the usual **gitflow** workflow as seen in ![gitflow image](https://i.stack.imgur.com/QxVmJ.png)
|
||||
|
||||
Report to Vincent Driessen page [a-successful-git-branching-model](http://nvie.com/posts/a-successful-git-branching-model/) for a detailed explanation of this workflow
|
||||
|
||||
Branches are named as follows:
|
||||
|
||||
|branch name| description |
|
||||
|-|-|
|
||||
|`master`|usual main git branch, always holds the last software version and its tag plus documents not changing the sw version |
|
||||
|`hotfix-vx.y.z`|hotfixes branches|
|
||||
|`release-vx.y.0`|releases branches, patch number should always be 0 here|
|
||||
|`develop`|dev branch|
|
||||
|`any name`|feature branches|
|
10
README.md
10
README.md
|
@ -13,7 +13,7 @@ rpn> 1 2 + 2 sqrt
|
|||
rpn> 256 prec
|
||||
rpn> pi
|
||||
3.1415926535897932384626433832795028841971693993751058209749445923078164062862
|
||||
rpn>
|
||||
rpn>
|
||||
```
|
||||
|
||||
### variables, programs
|
||||
|
@ -24,7 +24,7 @@ rpn> << -> x y << x y + ln >> >> 'P' sto
|
|||
|
||||
### and a bunch of functions
|
||||
```
|
||||
rpn>
|
||||
rpn>
|
||||
Display all 146 possibilities? (y or n)
|
||||
nop exit chs sqrt base xpon re r->p type and drop2 dupn str-> then ift repeat edit eval tan exp sinh
|
||||
help test neg sq sign floor im std > or dropn pick chr else ifte repea sto+ -> atan log10 asinh
|
||||
|
@ -37,12 +37,16 @@ q - pow bin mant max p->r default ==
|
|||
|
||||
## Download
|
||||
|
||||
deb, rpm and tgz files can be found [there](https://github.com/louisrubet/rpn/releases)
|
||||
deb, rpm and tgz files can be found [there](http://nvie.com/img/git-model@2x.png)
|
||||
|
||||
## Manual
|
||||
|
||||
A reference manual is provided [here](MANUAL.md)
|
||||
|
||||
## Methods
|
||||
|
||||
Development methods are set at [this page](METHODS.md)
|
||||
|
||||
## Generation
|
||||
|
||||
Generation instructions can be found [here](GENERATION.md)
|
||||
|
|
Loading…
Add table
Reference in a new issue