Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clarifications in README

Browse source
This commit is contained in:
Griatch 2020-04-10 11:19:39 +02:00
parent 2c1a80dd9e
commit d67b300e1e
1 changed files with 24 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

34
docs/README.md
View file

@ -1,10 +1,9 @@
# evennia-docs # evennia-docs
Documentation for the Evennia MUD creation system. Documentation for the Evennia MUD creation system.
> This system is still WIP and many things are bound to change! > WARNING: This system is still WIP and many things are bound to change!
> Contributing is still primarily to be done in the wiki. > Contributing is still primarily to be done in the wiki.
The live documentation is (will in the future be) available at `https://evennia.github.io/evennia/`. The live documentation is (will in the future be) available at `https://evennia.github.io/evennia/`.
# Editing the docs # Editing the docs
@ -44,9 +43,11 @@ All is done in your terminal/console.
- `cd` to into the `evennia/docs` folder (where this README is). - `cd` to into the `evennia/docs` folder (where this README is).
- Install the documentation-build requirements: - Install the documentation-build requirements:
```
make install make install
or or
pip install -r requirements.txt pip install -r requirements.txt
```
- Next we build the html-based documentation. - Next we build the html-based documentation.
@ -70,34 +71,41 @@ running)
- Create a new game folder called `gamedir` at the same level as your `evennia` - Create a new game folder called `gamedir` at the same level as your `evennia`
repo with repo with
```
evennia --init gamedir evennia --init gamedir
```
- Then `cd` into it and create a new, empty database. You don't need to start the game - Then `cd` into it and create a new, empty database. You don't need to start the game
or do any further changes. or do any further changes.
```
evennia migrate evennia migrate
```
- This is how the structure should look at this point: - This is how the structure should look at this point:
``` ```
(top) (top)
| |
----- evennia/ (the top-level folder, containing docs/) ----- evennia/ (the top-level folder, containing docs/)
| |
----- gamedir/ ----- gamedir/
``` ```
- Make sure you are still in your virtualenv, then go to `evennia/docs/` and - Make sure you are still in your virtualenv, then go to `evennia/docs/` and
install the doc-building requirements: install the doc-building requirements:
```
make install make install
or or
pip install -r requirements.txt pip install -r requirements.txt
```
- Finally, build the full documentation, including the auto-docs: - Finally, build the full documentation, including the auto-docs:
```
make local make local
```
- The rendered files will appear in a new folder `evennia/docs/build/html`. - The rendered files will appear in a new folder `evennia/docs/build/html`.
Note any errors from files you have edited. Note any errors from files you have edited.
@ -115,17 +123,23 @@ docs are built by looking at the git tree.
- To build for local checking, run (`mv` stands for "multi-version"): - To build for local checking, run (`mv` stands for "multi-version"):
```
make mv-local make mv-local
```
- Once all is built and it looks ok, run - Once all is built and it looks ok, run
```
make deploy make deploy
```
Note that this step requires git-push access to the Evennia `gh-pages` branch on `github`. Note that this step requires git-push access to the Evennia `gh-pages` branch on `github`.
If you know what you are doing you can also do If you know what you are doing you can also do
```
make release make release
```
This does the build + deploy steps in one go. After it finishes, the updated This does the build + deploy steps in one go. After it finishes, the updated
live documentation will be available at `https://evennia.github.io/evennia/`. live documentation will be available at `https://evennia.github.io/evennia/`.