diff --git a/README.md b/README.md index 7db80e4..b961279 100644 --- a/README.md +++ b/README.md @@ -5,20 +5,32 @@ application up and running. Things you may want to cover: -* Ruby version +## Ruby version -* System dependencies +## System dependencies -* Configuration +- poppler (PDF rendering libary) +- vips (Image processing libary) -* Database creation +## Configuration -* Database initialization +## Database creation -* How to run the test suite +```bash +rails db:create +``` -* Services (job queues, cache servers, search engines, etc.) +## Database initialization -* Deployment instructions +```bash +rails db:migrate +rails db:seed # (for developing) +``` -* ... +## How to run the test suite + +No tests for now.. ;) + +## Services (job queues, cache servers, search engines, etc.) + +## Deployment instructions