diff --git a/README.md b/README.md index 95030ad..034d12f 100644 --- a/README.md +++ b/README.md @@ -1 +1,17 @@ -## This work is licensed under a CC BY 4.0 licence. \ No newline at end of file +# 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. \ No newline at end of file