diff --git a/candid_server/README b/candid_server/README index 913f75f..0780447 100644 --- a/candid_server/README +++ b/candid_server/README @@ -3,6 +3,7 @@ A server that reads frames from a Controller Area Network (CAN) bus and relays them to connected clients over a TCP connection. Repository: https://gitlab.com/avandesa/candid-rs + Documentation: https://docs.rs/crate/candid_server/ ## Getting Started @@ -19,11 +20,9 @@ $ cargo install candid_server ``` To run the server on a `vcan0` interface and `localhost`: ``` -$ modprobe can -$ modprobe can_raw -$ modprobe vcan -$ sudo ip link add dev vcan0 type vcan -$ sudo ip link set up vcan0 +# modprobe can can_raw vcan +# ip link add dev vcan0 type vcan +# ip link set up vcan0 $ candid_server 127.0.0.1:6556 vcan0 ``` ## Built With @@ -42,4 +41,4 @@ We use [SemVer](http://semver.org/) for versioning. For the versions available, ## License -This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details