Release version 0.1.0

hannesbraun · Sep 2, 2021 · c6f3ed5 · c6f3ed5
1 parent b31235d
commit c6f3ed5
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,5 @@
+# Changelog
+
+0.1.0 (September 2, 2021)
+------------------------------
+*Initial release*
diff --git a/README.md b/README.md
@@ -0,0 +1,28 @@
+# Ayaya
+
+This is a simple and small tool to send some messages via the [Open Sound Control protocol](http://opensoundcontrol.org). You can use it to test out some OSC interfaces quickly.
+It may not include a lot of features, but it is quite handy for myself. Feel free to contribute more features if you need them.
+
+## Building
+
+On Linux systems, you need to install some dependencies for FLTK first. This is the appropriate command for an Ubuntu-based system:
+```bash
+sudo apt-get install -y libpango1.0-dev libx11-dev libxext-dev libxft-dev libxinerama-dev libxcursor-dev libxrender-dev libxfixes-dev libpng-dev
+```
+
+After that, it's just a regular build with Cargo.
+```bash
+cargo build --release
+```
+
+You will find the executable called `ayaya` within `target/release/`.
+
+## Contributors
+
+- [Hannes Braun](https://github.com/hannesbraun) - creator and maintainer
+
+## License
+
+Copyright (c) 2021, Hannes Braun
+
+Ayaya is licensed under the Boost Software License 1.0. For more information, see [LICENSE](LICENSE).