From 978f998cdd28ee8daec025e6df67651841309b7e Mon Sep 17 00:00:00 2001 From: Ales Katona Date: Fri, 25 Jan 2019 16:08:05 -0700 Subject: [PATCH] update links in README --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3b48980..7570f6f 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,11 @@ prongs = { version = "1.0.0", features = ["backend_piston"] } ### Documentation -[Documentation link](docs/index.html) +[Documentation link](https://doc.bitsmart.ltd/prongs/index.html) ### Examples -See [examples repo](../prongs-examples) +See [examples repo](https://gitlab.bitsmart.ltd/open/prongs-examples) ### Design @@ -38,7 +38,7 @@ Prongs abstracts input events into a three layered structure. The layers are: 2. Instance of input, e.g. key "k", mouse button #2 or axis #2 3. State of input, e.g. button pressed/released or value of axis -This is expressed best in the [InputCause](docs/types/enum.InputCause.html) enum. +This is expressed best in the [InputCause](https://doc.bitsmart.ltd/prongs/types/enum.InputCause.html) enum. The library does not run any event loop due to various differences between how backends handle the event loop. To use prongs you need to define an actions type that will identify the mappings on input events. @@ -66,4 +66,5 @@ Because the Schema object is fully serializable you can also load existing setup To build you need to specify the required backends e.g. `cargo build --features backend_piston,backend_gilrs` Same goes for testing `cargo test --features backend_piston,backend_gilrs` -If you don't specify a backend the tests for it will not be compiled and won't run. \ No newline at end of file +If you don't specify a backend the tests for it will not be compiled and won't run. +