aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..90c848e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# Trenord
+
+Get information about trains in Lombardy.
+
+```
+$ trenord
+USAGE: trenord [-n #trains] [-@ time] [-v] FROM TO
+```
+
+## Dependencies
+
+- [Rust](https://rust-lang.org)
+- [Cargo](https://doc.rust-lang.org/stable/cargo/)
+
+## Build from source
+
+```
+$ cargo build
+```
+
+## Install
+
+```
+$ cargo install --profile release --path .
+```
+
+Make sure that `$HOME/.cargo/bin` is in your `$PATH`.
+
+# License
+
+Trenord is released under the terms of the GNU General Public License, either
+version 3 of the license or, at your discretion, any later version. See the
+LICENSE file for information.