Updated man, documentation and CI

This commit is contained in:
Marco Cetica 2024-03-01 10:31:00 +01:00
parent 62ccddafc9
commit 748956622e
Signed by: marco
GPG Key ID: 45060A949E90D0FD
4 changed files with 15 additions and 2 deletions

View File

@ -1,7 +1,7 @@
name: dc
on:
push:
branches: [master, unit_testing]
branches: [master]
workflow_dispatch:
jobs:
@ -16,3 +16,6 @@ jobs:
mkdir build && cd build
cmake ..
make
- name: Run unit tests
run: |
./utest.sh tests

View File

@ -15,3 +15,6 @@ jobs:
mkdir build && cd build
cmake ..
make
- name: Run unit tests
run: |
./utest.sh tests

View File

@ -83,6 +83,13 @@ $> sudo pacman -U dc-<VERSION>-1-x86_64.pkg.tar.zst
You can find the binaries on the release page or on the `bin` folder
of this repository.
## Unit tests
This repository as well as the CI pipeline provides unit tests for the
program's features. To run them, issue the following command:
```sh
$> ./utest.sh tests
```
## Usage
dc can be used in three different ways:

2
man.md
View File

@ -295,7 +295,7 @@ The previous of the register becomes inaccessible, thus it follows the LIFO poli
**L**`r`
Pop the value off the top of register _r_'s stack and push it onto the main stack. The previous value in register _r_'s stack, if any,
is now accessible via the **b**r command.
is now accessible via the **l**r command.
## Register(Array)
Arrays support random access through an index. You can store a value in an array and retrieve it later.