1 changed files with 4 additions and 20 deletions
Unified View
Diff Options
-
+4 -20README.md
+ 4
- 20
README.md
View File
| @ -1,27 +1,11 @@ | |||||
| # three-tier | # three-tier | ||||
| TODO: Write a description here | |||||
| ## Installation | ## Installation | ||||
| TODO: Write installation instructions here | |||||
| ## Usage | |||||
| TODO: Write usage instructions here | |||||
| ## Development | |||||
| TODO: Write development instructions here | |||||
| ## Contributing | |||||
| 1. Fork it (<https://github.com/your-github-user/three-tier/fork>) | |||||
| 2. Create your feature branch (`git checkout -b my-new-feature`) | |||||
| 3. Commit your changes (`git commit -am 'Add some feature'`) | |||||
| 4. Push to the branch (`git push origin my-new-feature`) | |||||
| 5. Create a new Pull Request | |||||
| - Install liblua and crystal | |||||
| - Run `shards install` to get the dependencies | |||||
| - Run with `crystal run src/three-tier.cr` | |||||
| ## Contributors | ## Contributors | ||||
| - [Ludovic 'Archivist' Lagouardette](https://github.com/your-github-user) - creator and maintainer | |||||
| - [Ludovic 'Archivist' Lagouardette](https://git.nekoit.xyz/Archivist) - creator and maintainer | |||||