docs: add docs

Signed-off-by: kjuulh <contact@kjuulh.io>
This commit is contained in:
2023-08-02 14:11:29 +02:00
parent f7a6ea5d83
commit decdf5f777
5 changed files with 296 additions and 12 deletions

29
docs/installation.md Normal file
View File

@@ -0,0 +1,29 @@
# Installation
## Cargo version
```bash
cargo install cuddle-please
# or
cargo binstall cuddle-please # if using binstall
```
More to come as the project matures.
## Development version
### Cuddle
[Cuddle](https://git.front.kjuulh.io/kjuulh/cuddle) is a script and configuration management tool, it is by far the easiest approach for building the development version of cuddle-please, but optional.
```bash
cuddle x build:release
# or docker
cuddle x build:docker:release
```
### Cargo
```bash
cargo build --release -p cuddle_cli
```