docs

CHANGELOG.md

@@ -5,6 +5,7 @@ The format is based on [Keep a Changelog](changelog),
 and this project adheres to [Semantic Versioning](semver).
 
 ## [Unreleased]
+- Dark Elf - Bitter Reminders rules
 - Troll stock
 - Add emotional attributes to the PDF
 - Add a page to the pdf for Health + Steel questions

README.md

@@ -2,19 +2,14 @@
 
 The unofficial, online, Burning Wheel Gold (+Codex) character burner. Adapted from [Charred](https://charred.herokuapp.com/).
 
-## Deploy Steps
-
-_This is mine, it won't work for you._
-
-See: [Heroku - Container Registry and Runtime](https://devcenter.heroku.com/articles/container-registry-and-runtime)
-
-```
-heroku login
-heroku container:login
-heroku container:push web -a charred-black
-heroku container:release web -a charred-black
-heroku open
-```
+## Project Structure
+
+* `Dockerfile` and `Dockerfile.dev` - Container definition files. The dev container has automated reloading if you mount the container's filesystem to the host machine. If you are unfamiliar with Docker, this app uses Sinatra and you can _probably_ get by with a bundle install and `ruby ./src/app.rb`.
+`src/data` - Binaries and data files for lifepaths live here, see `dark_elf` and `wizard` directory for well-defined examples
+* `src/lib` - Ruby scripts for caching, PDF generation, and data loading
+* `src/public` - Javascript and CSS
+* `src/views` - HTML templates
+* `src/app.rb` - The webapp, uses Sinatra
 
 ## Beliefs