aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Cargo.toml5
-rw-r--r--LICENSE19
-rw-r--r--README.md19
3 files changed, 43 insertions, 0 deletions
diff --git a/Cargo.toml b/Cargo.toml
index b6c1c90..7875c64 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -3,6 +3,11 @@ name = "evtclib"
version = "0.1.0"
authors = ["Daniel"]
edition = "2018"
+description = "An evtc parsing library"
+readme = "README.md"
+repository = "https://gitlab.com/dunj3/evtclib"
+license = "MIT"
+license-file = "LICENSE"
[dependencies]
num-traits = "0.2"
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..89fcd81
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,19 @@
+Copyright 2020 Daniel Schadt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..67f61df
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+evtclib
+#######
+
+`evtclib` is a Rust library that allows you to parse `.evtc` files, as
+generated by the [arcdps addon](https://www.deltaconnected.com/arcdps/) for the
+Guild Wars 2 video game.
+
+It supports a low-level parsing interface and a higher-level interface which
+interprets some of the data and converts it to a more appropriate interface.
+
+`evtclib` uses `cargo` as its build tool and as such can be included as a
+dependency in other Rust projects. API docs can be generated locally by running
+`cargo doc`.
+
+License
+-------
+
+This project is licensed under the MIT license (`LICENSE` or
+https://opensource.org/licenses/MIT).