Skip to content

Commit ea1b572

Browse files
committed
Add readme and contributing
1 parent b08416a commit ea1b572

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

+17-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,17 @@
1-
## This work is licensed under a CC BY 4.0 licence.
1+
# FerrumC Documentation
2+
This is the public repository for our documentation.\
3+
You can access the docs [here](https://ferrumc-rs.github.io/docs).
4+
5+
## Contributing
6+
Want to contribute? See the below guide.
7+
8+
1. [Fork the repository](https://github.com/ferrumc-rs/docs/fork) and then clone it.
9+
```bash
10+
git clone https://github.com/user/docs
11+
```
12+
13+
2. Open a terminal in the new cloned repository folder and run `npm install`. This will install necessary dependencies.
14+
15+
3. Run `npm run dev` to start a dev server. You will be provided with a link that will update automatically on changes.
16+
17+
4. Make your changes! Experiment, and then open a PR.

0 commit comments

Comments
 (0)