From 9584309dad2df927b97f26a84d9145a8db64157e Mon Sep 17 00:00:00 2001
From: Alex van de Sandt <avandesa@purdue.edu>
Date: Thu, 15 Nov 2018 22:26:30 -0500
Subject: [PATCH] Add readme for server

---
 candid_server/README.md | 45 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 candid_server/README.md

diff --git a/candid_server/README.md b/candid_server/README.md
new file mode 100644
index 0000000..913f75f
--- /dev/null
+++ b/candid_server/README.md
@@ -0,0 +1,45 @@
+# CANdid Server
+
+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
+
+### Prerequisites
+
+Because the server uses the [socketcan](https://crates.io/crates/socketcan) crate, a wrapper for the Linux SocketCAN kernel module, the server can only run  on a Linux system with the relevant modules compiled and loaded.
+
+### Installing
+
+To install the server:
+```
+$ 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
+$ candid_server 127.0.0.1:6556 vcan0
+```
+## Built With
+
+* [SocketCAN](https://www.kernel.org/doc/html/v4.16/networking/can.html) - The underlying kernel module.
+* [socketcan Crate](https://crates.io/crates/socketcan) - Rust bindings for the C library.
+* [clap](https://crates.io/crates/clap) - For command line argument parsing.
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://gitlab.com/avandesa/candid-rs/tags). 
+
+## Authors
+
+* **Alex van de Sandt** - [avandesa](https://gitlab.com/avandesa)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
-- 
2.51.2