Skip to content

Commit

Permalink
update installation docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Vandesm14 committed Feb 10, 2024
1 parent e47ee85 commit 5aa496d
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,22 @@ An RPN stack machine built with Rust

## Documentation

All documentation, the who, what, when, where, and why, can be found in the [docs](./docs) directory.
All documentation, the who, what, when, where, and why, can be found in the [docs](./docs) directory.

### Running with mdbook

To run the documentation locally, you can use `mdbook`. To install `mdbook`, you can use `cargo`:

```sh
cargo install mdbook
```

Then, to run the documentation, you can use the following command:

```sh
# Enter the docs directory
cd docs

# Run mdbook
mdbook serve --open
```
6 changes: 6 additions & 0 deletions docs/src/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
Stack is currently not in the cargo registry, so to install, you must clone the repo and install it manually.

```bash
# Clone the repo
git clone https://github.com/vandesm14/stack

# Move into the directory
cd stack

# After cloning the repo
cargo install --path .

Expand Down

0 comments on commit 5aa496d

Please sign in to comment.