tsv
/
Soc
1
0
Fork 0
Code Issues 4 Pull Requests 1 Actions Wiki Activity

Added README

This commit is contained in:
Trevor Vallender 2023-08-19 16:46:43 +01:00
parent 552935f5c7
commit d5b5bbdbfd
1 changed files with 12 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,24 +1,18 @@
# README # Summon Player
This README would normally document whatever steps are necessary to get the Summon player is a lightweight digital helper for tabletop games. It is designed
application up and running. for use in a few situations:
- To use for theatre of the mind games alongside a video call platform
- To use alongside a platform such as Owlbear Rodeo
- For Play-by-Post games
- To manage in-person games
Things you may want to cover: # Development environment
* Ruby version Uses [devenv](https://devenv.sh). If you wish to run outside of this you should
still be able to use `devenv.nix` as documentation of what is required.
* System dependencies # Deployment
* Configuration The plan is to use MRSK for deployment.
* Database creation
* Database initialization
* How to run the test suite
* Services (job queues, cache servers, search engines, etc.)
* Deployment instructions
* ...