From 9029a9b88623008b1e0e85bf18e3f5e510118f4e Mon Sep 17 00:00:00 2001
From: Takumi Sueda <puhitaku@gmail.com>
Date: Tue, 12 Apr 2022 01:38:12 +0900
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b436281
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+BrainLILO
+=========
+
+*Jump to U-Boot directly from Windows CE running on a SHARP Brain.*
+
+
+Build on x86_64 Linux
+---------------------
+
+1. Get [cegcc](https://github.com/brain-hackers/cegcc-build/releases) and unzip it
+2. Copy the directory `cegcc` into `/opt`
+3. Run `make` with the `PREFIX` specified
+
+Equivalent shell snippet:
+
+```shell
+wget -O cegcc.zip https://github.com/brain-hackers/cegcc-build/releases/download/2022-04-11-133546/cegcc-2022-04-11-133546.zip
+unzip -q cegcc.zip
+mkdir -p /opt  # it may need sudo
+cp -r cegcc /opt/  # it may need sudo
+make PREFIX=/opt/cegcc
+```
+
+
+Install (using the pre-built binary)
+------------------------------------
+
+1. Download the ZIP in [the latest release](https://github.com/brain-hackers/brainlilo/releases) and unzip it
+2. Create `アプリ` directory in the SD card's root directory and copy `BrainLILO` into it
+3. Create `LOADER` directory in the SD card's root directory and copy `u-boot.bin` into it
+
+
+Install (using your binary)
+---------------------------
+
+1. Create a directory named `BrainLILO`
+2. Copy dlls and the exe into it, renaming BrainLILO.exe to AppMain.exe
+3. Create a blank `index.din` in the directory
+4. Follow the step 2 and 3 in [Install (using the pre-built binary)](#install-using-the-pre-built-binary)
+
+Equivalent shell snippet:
+
+```shell
+mkdir BrainLILO
+cp *.dll BrainLILO/
+cp BrainLILO.exe BrainLILO/AppMain.exe
+touch BrainLILO/index.din
+```