diff --git a/README.md b/README.md index 1e2439a..461d99e 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,24 @@ -# andrew +# Andrew -TODO: Write a description here +Code generator to generate network packet parsers in C++ from YAML ## Installation -TODO: Write installation instructions here +```bash +crystal build src/andrew.cr +sudo chown root andrew +sudo chmod 0555 andrew +sudo mv andrew /usr/local/bin/ +``` ## Usage -TODO: Write usage instructions here +```bash +andrew tests/record.yml > record.cpp +``` -## Development - -TODO: Write development instructions here - -## Contributing - -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 +See examples in `/tests/` ## Contributors -- [your-name-here](https://github.com/your-github-user) - creator and maintainer +- [Ludovic 'Archivist' Lagouardette](https://git.nekoit.xyz/Archivist) - creator and maintainer