summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2018-07-23 20:19:02 +0300
committerYuval Adam <_@yuv.al>2018-07-23 20:19:02 +0300
commit52162d8efa5a646c16f42cb6718ff96bd80a08ad (patch)
tree5c43f353e4dd66a551951cfb368bc72ea9babac7 /README.md
parentb19f35cbc702f3855db52824e26939093148f1b9 (diff)
Update README and LICENSE
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index 7ce21e7..c63771b 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,18 @@
# RusTL
-A pure Rust implementation of the RTL-SDR driver.
+A pure Rust implementation of the [RTL-SDR](https://github.com/osmocom/rtl-sdr/) driver.
+
+This is mostly an exercise in writing low-level driver code and is unlikely to ever become seriously useful.
+
+## Dev
+
+The usual:
+
+```bash
+$ cargo build
+$ cargo test
+```
+
+## License
+
+[GPLv3](LICENSE)