Skip to content

Commit 541dcab

Browse files
committed
Update README
Add new relevant information to the readme file. Close #32
1 parent bdfa4af commit 541dcab

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,25 @@ This program was designed to assist the GM by quickly creating a random star sys
1212

1313
## How do I use this?
1414

15+
### CLI Version
1516
Basically, download the code and put it in a folder. Currently installing as a Python module onto the system is not supported, but will come in the future. Some day.
1617

1718
After that have a look at the `example.py` file and modify it to suit your needs. Currently not many options are available, but there will be more!
1819

20+
### Web Version
21+
In v0.3 we introduced a web interface which is self-hosting, meaning that all the work is done locally on your machine. Navigate to the `web-gui` directory and start the server with the command
22+
23+
python3 server.py
24+
25+
If they are not already on your system, you need to install the 3<sup>rd</sup> party modules `cherrypy` and `jinja2`.
26+
An easy way to do that is with pip3:
27+
28+
pip3 install cherrypy jinja2
29+
30+
31+
When the server is up and running, open your favorite browser and navigate to `localhost:8080` where you can interact with the software.
32+
33+
1934
## I found a bug!
2035

2136
If you found something that is not working as it should, please report it in the *issues* section here: http://github.com/tschoppi/starsystem-gen/issues

0 commit comments

Comments
 (0)