Minecraft-Console-Client/docs/.vuepress/public/README.md
2022-11-07 11:15:19 +08:00

39 lines
621 B
Markdown

# About
A documentation website for Minecraft Console Client (MCC) written using [Vue Press 2.0](https://v2.vuepress.vuejs.org/)
## How to contribute
### Requirements:
- Git
- Node JS >= v12
- Yarn
### Install Yarn if you don't have it:
```bash
npm i yarn -g
```
Fork and clone the repository `Minecraft-Console-Client`.
All of the source is in the `docs` directory.
### Install dependencies:
```bash
yarn install
```
### Run developer mode:
```bash
yarn docs:dev
```
_If you have the port `8080` taken, use the `--port <port>` for a custom port._
Change things
Commit, push and open a pull request.