Skip to content

Commit 5ca5f48

Browse files
committed
Adds Installation instructions to README
All of the other parts of the toolchain have an Installation section with compilation instructions, but patchrom did not. This commit copies the instructions from mkrom which appear to be sufficient for compiling and installing patchrom on GNU/Linux. Signed-off-by: zachwick <zach@zachwick.com>
1 parent 2aa708a commit 5ca5f48

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,18 @@
33
Patches a ROM file with a jump table and generates the necessary jump table
44
index definitions.
55

6+
## Installation
7+
8+
For Linux/Mac/etc, install cmake, make, asciidoc, and a C compiler,
9+
then:
10+
11+
$ cmake .
12+
$ make
13+
# make install # as root
14+
15+
On Windows, do the same thing under cygwin after installing cmake,
16+
your favorite C compiler, and asciidoc.
17+
618
## Help, Bugs, Feedback
719

820
If you need help with KnightOS, want to keep up with progress, chat with

0 commit comments

Comments
 (0)