๐Ÿ“ฆ RobLoach / unciv-mods

๐Ÿ“„ README.md ยท 33 lines
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33# Unciv Mods

Lists all the available Unciv mods, in a website, and a mods.json manifest file.

## Development

1. Install mkdocs
    ```
    sudo apt install mkdocs
    ```

2. Install dependencies
    ```
    pip install mkdocs-material mkdocs-awesome-pages-plugin
    ```

3. Generate a [GitHub Token](https://github.com/settings/personal-access-tokens/new?name=Unciv-Mods-GitHub-Pages)

4. Run the build process
    ```
    GITHUB_TOKEN=github_pat_abc python3 build.py
    ```

5. Test the docs
    ```
    mkdocs serve
    ```

6. Deploy
    ```
    mkdocs gh-deploy
    ```