README.md in hackathon_manager-0.2.0 vs README.md in hackathon_manager-0.3.0
- old
+ new
@@ -51,32 +51,21 @@
Now, add our database migrations:
```bash
$ bin/rails railties:install:migrations
```
-And finally, create the file `config/hackathon.yml`:
+And finally, create the a `config/hackathon.yml` with the contents from [test/dummy/config/hackathon.yml](test/dummy/config/hackathon.yml). Be sure to make any necessary customizations!
-```yaml
-defaults: &defaults
- registration_is_open: true
- event_is_over: false
- last_day_to_apply: <%= Date.new(2017, 2, 11) %>
- auto_late_waitlist: false
- logo_asset: logo.png
+### Customization
-development:
- <<: *defaults
+* **Emails**: The default email templates are located at [`/app/views/mailer`](https://github.com/codeRIT/brickhack.io/tree/develop/app/views/mailer). You can override these templates by copying the specific template(s) to the same `/app/views/mailer` in your Rails app and making the changes you need.
+* **Styling**: The style for management, application, and RSVP pages can be customized by modifying your Rails app's `/app/assets/stylesheets/variable-overrides.sass` file. You can see the defaults in the hackathon_manager [`varaibles.sass`](https://github.com/codeRIT/hackathon_manager/blob/master/app/assets/stylesheets/variables.sass). The style for all other pages is controlled by your own stylesheets - hackathon_manager does not control those.
-test: &test
- <<: *defaults
- last_day_to_apply: <%= 2.months.from_now %>
+## Deployment
-production:
- <<: *defaults
+Deployment to Heroku and Dokku is supported out of the box, though anything that operates on Heroku's buildpacks should work too.
-staging:
- <<: *defaults
-```
+See [BrickHack's production setup](https://github.com/codeRIT/brickhack.io/wiki/Production-Environment-Setup) for detailed notes.
## Contributing
GitHub issues and pull requests welcome!