18 lines
626 B
Markdown
18 lines
626 B
Markdown
# CERC Software Development Team Documentation
|
|
|
|
This repository contains the CERC Software Development Team's documentation.
|
|
|
|
## Prerequisites
|
|
|
|
- [Git](https://git-scm.com/)
|
|
- [Rust](https://www.rust-lang.org/tools/install)
|
|
- [mdbook](https://rust-lang.github.io/mdBook/guide/installation.html)
|
|
|
|
## Editing
|
|
|
|
- Clone this repo: `git clone https://nextgenerations-cities.encs.concordia.ca/gitea/a_nguyen/dev-docs-tmp`
|
|
- `cd` into the repo: `cd /path/to/dev-docs-tmp`
|
|
- Run `mdbook serve --open` to start the development server.
|
|
- Edit the markdown files in the `src` folder.
|
|
- After making edits, commit and push the changes.
|