contributing information on the site + README stuff
This commit is contained in:
parent
de49e994ab
commit
76dce798b9
25
README.md
25
README.md
|
@ -1,3 +1,26 @@
|
||||||
# ttrpg-site
|
# ttrpg-site
|
||||||
|
|
||||||
Content for my tabletop RPG site (orb.moe).
|
Content for my tabletop RPG site, orb.moe.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
The site is mostly written in Markdown, and can be edited in whatever text editor you desire. If you make changes, you
|
||||||
|
just need to send me a merge request or Git patch set. I recommend using my Git site to either fork the project or
|
||||||
|
request direct access to my copy of the project, and submit your merge request that way.
|
||||||
|
|
||||||
|
## Hosting
|
||||||
|
|
||||||
|
The companion software to this repository is my CMS, [incorporeal-cms](https://git.incorporeal.org/bss/incorporeal-cms).
|
||||||
|
If you want to run your own version, to see the content how it'd be served, here is the short version of a local setup:
|
||||||
|
|
||||||
|
```
|
||||||
|
% mkdir orb.moe
|
||||||
|
% cd orb.moe
|
||||||
|
% virtualenv --python=python3.10 env-py3.10
|
||||||
|
% source env-py3.10/bin/activate
|
||||||
|
% pip install -U -f https://bss.zone/tech/incorporeal-cms/ incorporeal-cms[dot]
|
||||||
|
% mkdir env-py3.10/var
|
||||||
|
% mkdir env-py3.10/var/incorporealcms-instance
|
||||||
|
% [copy this repository's files into env-py3.10/var/incorporealcms-instance/]
|
||||||
|
% FLASK_APP=incorporealcms FLASK_ENV=development flask run -h 0.0.0.0
|
||||||
|
```
|
||||||
|
|
|
@ -12,3 +12,8 @@ The tabletop RPG repository of [bss](https://bss.zone/) and friends.
|
||||||
## Systems
|
## Systems
|
||||||
|
|
||||||
* [13th Age](13th-age) --- bss's favorite D&D-like.
|
* [13th Age](13th-age) --- bss's favorite D&D-like.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
The source of this site is tracked in a Git repository, hosted at <https://git.incorporeal.org/bss/ttrpg-site>. Friends
|
||||||
|
are welcome to contribute to the site, check out the repository and read the README.
|
||||||
|
|
Loading…
Reference in New Issue