-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
17 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |