summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJakob Kaivo <jakob@kaivo.net>2018-11-10 14:13:36 -0500
committerJakob Kaivo <jakob@kaivo.net>2018-11-10 14:13:36 -0500
commit1a3b0705cce6aea414c15fe7c60a9355b281b9dc (patch)
tree69883e742f4d74d27ec14772585e7f0300e712fa /README.md
parent21de9806066a951f5a82e9aca0bbeb0acd3d2406 (diff)
add some more instructions to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/README.md b/README.md
index 06a472e..43b5468 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,18 @@
# freeonebook
-To use, compile:
+In order to compile this, you will need an ARM cross compiler (unless you are
+building natively on ARM, in which case skip this step). On Debian, this is
+easy with:
+
+ $ sudo apt install gcc-arm-linux-gnueabihf
+
+To compile, simply run `make`.
$ make
Then copy freeonebook to `.a001` on your SD card:
$ cp freeonebook /path/to/sd/.a001
+
+Insert your SD card into your eOneBook and open it up. The program will run
+automatically.