summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJakob Kaivo <jakob@kaivo.net>2018-11-12 10:42:20 -0500
committerJakob Kaivo <jakob@kaivo.net>2018-11-12 10:42:20 -0500
commit72386a1678a0cac81b865e4ff1c7991578b9b0f3 (patch)
tree8578d9fb8ce14bc93c1f90302e1b190a27181501
parent329ead8346180ba22fb0f365b38da1957d0147ed (diff)
split into sections
-rw-r--r--README.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/README.md b/README.md
index 43b5468..b7f01fc 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,28 @@
# freeonebook
+## Compiling
+
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
+ $ sudo apt install gcc-arm-linux-gnueabihf make
To compile, simply run `make`.
$ make
-Then copy freeonebook to `.a001` on your SD card:
+## Installing
+
+Copy `freeonebook` to `.a001` on your SD card:
$ cp freeonebook /path/to/sd/.a001
+## Using
+
Insert your SD card into your eOneBook and open it up. The program will run
automatically.
+
+At present, the program is in pre-alpha state and simply initializes the
+display, logs button presses to `stdout`, and cleanly shuts down when requested
+by closing the eOneBook. Don't expect much.