From 76dce798b93e99ddb28d0d9ec47bde792ca81162 Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Wed, 30 Nov 2022 23:57:37 -0600 Subject: [PATCH] contributing information on the site + README stuff --- README.md | 25 ++++++++++++++++++++++++- pages/index.md | 5 +++++ 2 files changed, 29 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d6ee910..38e8af0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,26 @@ # ttrpg-site -Content for my tabletop RPG site (orb.moe). \ No newline at end of file +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 +``` diff --git a/pages/index.md b/pages/index.md index bb803f4..440d131 100644 --- a/pages/index.md +++ b/pages/index.md @@ -12,3 +12,8 @@ The tabletop RPG repository of [bss](https://bss.zone/) and friends. ## Systems * [13th Age](13th-age) --- bss's favorite D&D-like. + +## Contributing + +The source of this site is tracked in a Git repository, hosted at . Friends +are welcome to contribute to the site, check out the repository and read the README.