From 82ffd7bcc4d690b62b727b1cb669c4072abe9073 Mon Sep 17 00:00:00 2001 From: Archivist Date: Wed, 17 Nov 2021 13:21:45 +0000 Subject: [PATCH] Update 'README.md' --- README.md | 24 ++++++------------------ 1 file changed, 6 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 1cc2ce1..5aa1362 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,15 @@ # three-tier -TODO: Write a description here - ## Installation -TODO: Write installation instructions here - -## Usage - -TODO: Write usage instructions here - -## Development - -TODO: Write development instructions here +- Install liblua and crystal +- Run `shards install` to get the dependencies +- Run with `crystal run src/three-tier.cr` -## Contributing +## Hacking around -1. Fork it () -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 +Chnage the script in `./scripts/` to alter the behaviour. ## Contributors -- [Ludovic 'Archivist' Lagouardette](https://github.com/your-github-user) - creator and maintainer +- [Ludovic 'Archivist' Lagouardette](https://git.nekoit.xyz/Archivist) - creator and maintainer