Merge branch 'categulario/readme' into 'master'

a start of a readme that tells you what to do See merge request kirbylife/rvgax!1
2021-04-27 16:42:34 +00:00 · 2021-04-27 16:42:34 +00:00 · 6532c85ceb
parent e19764d7b2 07e024811d
commit 6532c85ceb
1 changed files with 14 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -1,3 +1,17 @@
 # rVGAx

+A VGA library for arduino
+
+## Compiling
+
+You need rust nightly, run:
+
+    rustup override set nightly
+
+in the project directory. then you can do
+
+    cargo check
+
+to see that everything is allright
+
 ## WIP, DOES NOT WORK :c