Skip to content

Commit fac05d5

Browse files
committed
added instructions to maintainers
1 parent 199b59d commit fac05d5

File tree

1 file changed

+54
-1
lines changed

1 file changed

+54
-1
lines changed

README.md

+54-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,57 @@
22

33
Files needed to generate [RetroAchievements.org documentation pages](https://retroachievements.github.io/docs/)
44

5-
More info about how it works [here](https://github.com/RetroAchievements/docs/wiki/About).
5+
The **RetroAchievements Documentation Project** is divided into two parts:
6+
7+
1. **[RAwiki](https://github.com/RetroAchievements/docs/wiki/)**
8+
2. **[RAdocs](https://retroachievements.github.io/docs/)**
9+
10+
The wiki is where the documents are created and edited. Anyone (with a github account) is able to edit the wiki's content. Then, if you have something to share, please edit the wiki!
11+
12+
The [RAdocs](https://retroachievements.github.io/docs/) website has (almost) the same content as the wiki, but with a more pleasant look. The content of this website is generated by its maintainers using the wiki's content as input.
13+
14+
**When a change is made in the wiki this change is NOT instantaneously reflected in the docs.** The convertion is performed by a maintainer from time to time.
15+
16+
17+
## Generating RAdocs pages
18+
19+
[No need to continue reading if you're not a RAdocs maintainer.]
20+
21+
22+
### dependencies
23+
24+
**Windows**
25+
26+
You'll need to install [Cygwin](https://cygwin.com/), and the following packages: `git`, `python3`, `python3-pip` and `libyaml-devel`.
27+
28+
After installing the needed packages, perform this command:
29+
30+
```
31+
pip install --upgrade mkdocs mkdocs-material
32+
```
33+
34+
35+
36+
### cloning the repo
37+
38+
After installing the dependencies, open a terminal and clone the repo with this command:
39+
40+
```
41+
git clone --depth 1 --recursive https://github.com/RetroAchievements/docs
42+
```
43+
44+
**Note**: don't forget the `--recursive` option.
45+
46+
It creates a folder named `docs`. Just "enter" it using:
47+
48+
```
49+
cd docs
50+
```
51+
52+
53+
### `generate-docs.sh`
54+
55+
The `generate-docs.sh` is the script you'll be using to generate the pages for RAdocs. Run it with `--help` and see how it works. It's pretty straightforward.
56+
57+
**Note**: only the wiki pages listed on the wiki's sidebar will be converted into RAdocs pages.
58+

0 commit comments

Comments
 (0)