Skip to content

Commit

Permalink
docs: add installation and developers sections (#17)
Browse files Browse the repository at this point in the history
* docs: add installation to readme

* docs: add developers getting started section
  • Loading branch information
MarcosNicolau authored Jan 7, 2025
1 parent 2bee5ec commit 9ac2f00
Showing 1 changed file with 68 additions and 0 deletions.
68 changes: 68 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,74 @@ Glossary:
> [!NOTE]
> This is just an initial roadmap to define the scope of the lib. They are not definitive and may vary in the future as we explore and work.
## Installation

To install the library globally in your system run:

```shell
make install
```

To uninstall:

```shell
make uninstall
```

To install the CLI program in your system run:

```shell
make cli_install
almunecar --help
```

To uninstall:

```shell
make cli_uninstall
```

## Developers

To start developing, you'll need to compile the libs:

```shell
make build
```

Whenever you make a change on a lib, you'll need to re-build to see its effects.

To build and run the cli program:

```shell
make cli_build
./build/almunecar --help
```

To run tests:

```shell
make test
```

To run test of a specific lib:

```shell
make test_<LIB_NAME>
```

for example:

```shell
make test_primitive-types
```

See all available commands:

```shell
make help
```

---

### References
Expand Down

0 comments on commit 9ac2f00

Please sign in to comment.