Skip to content

Commit

Permalink
Add readme and contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
Skullians committed Nov 9, 2024
1 parent b08416a commit ea1b572
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,17 @@
## This work is licensed under a CC BY 4.0 licence.
# FerrumC Documentation
This is the public repository for our documentation.\
You can access the docs [here](https://ferrumc-rs.github.io/docs).

## Contributing
Want to contribute? See the below guide.

1. [Fork the repository](https://github.com/ferrumc-rs/docs/fork) and then clone it.
```bash
git clone https://github.com/user/docs
```

2. Open a terminal in the new cloned repository folder and run `npm install`. This will install necessary dependencies.

3. Run `npm run dev` to start a dev server. You will be provided with a link that will update automatically on changes.

4. Make your changes! Experiment, and then open a PR.

0 comments on commit ea1b572

Please sign in to comment.