Unverified Commit 554a92bd authored by Kiryuu's avatar Kiryuu
Browse files

Add README.md

parent eeefb875
This is where the docs at.
## Contribute
If you find a gap or mistake in existing documents, or you want to create new documents to cover something that isn’t covered yet, you can follow this procedure to contribute.
## Setup
Nekoshima’s documentation is written using [reStructuredText](https://docs.funkwhale.audio/documentation/restructured.html) and is built using [Sphinx](http://www.sphinx-doc.org/).
### Text Editor
As reStructuredText is a writing standard, any text editor can be used to modify documents depending on preference. We use [VS Code](https://code.visualstudio.com/), but you can use other software like [Vim](https://www.vim.org/) or [Emacs](https://www.gnu.org/software/emacs/).
### Sphinx
Sphinx is used to generate a static site based on the `.rst` files in the `source` directory. When writing documents, it can be useful to build the site to see how your changes will look in production. First, clone this repo:
```
git clone https://code.misakanet.cn/nekoshima/docs.git
```
Then install the requirements using `pip`:
```
pip install -r requirements.txt
```
Then, use the make file to build the site:
```
make html
```
Sphinx will generate the site in your `build` directory.
### Git
In order to work on files on your computer, you will need to install [git](https://git-scm.com/) for your operating system. Git is used to push and pull files to and from the Nekoshima repository and track changes made to documents/code alike.
### Gitlab
If you are only making minor changes to a document or don’t wish to install anything, you can use [Gitlab’s built-in IDE](https://code.misakanet.cn/). Once you have made an account and created a pull request, you can click on the “Open in Web IDE” button to open up a fully-fledged editor in your web browser.
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment