path: root/docs/prerequisite.txt
diff options
authorWaldemar Brodkorb <>2014-03-16 19:51:41 +0100
committerWaldemar Brodkorb <>2014-03-16 19:51:41 +0100
commit9d097a780c0ffe2c9dbe146046d5b68123c47708 (patch)
treebf05111572c2a996d0c911c2fe30075aab6de496 /docs/prerequisite.txt
parentf6161af2d6f3e0ed683fe77450aa2f9fe9ec100b (diff)
add OpenADK manual.
Diffstat (limited to 'docs/prerequisite.txt')
1 files changed, 52 insertions, 0 deletions
diff --git a/docs/prerequisite.txt b/docs/prerequisite.txt
new file mode 100644
index 000000000..8a9670066
--- /dev/null
+++ b/docs/prerequisite.txt
@@ -0,0 +1,52 @@
+// -*- mode:doc; -*-
+// vim: set syntax=asciidoc:
+System requirements
+OpenADK is designed to run on Linux systems. But there is basic
+support to run on MacOS X Maverick, Windows 7 with Cygwin, OpenBSD,
+NetBSD and FreeBSD. Main development happens on Debian/GNU Linux 7
+and MacOS X Maverick. The other host platforms are occasionally
+OpenADK detects the host system and displays only the software
+packages, which are known to be cross-compilable on the used host.
+For example OpenJDK7 is only cross-compilable on a Linux host.
+OpenADK needs some software to be already installed on the host
+system; here is the list of the mandatory packages,
+package names may vary between host systems.
+* Build tools:
+** +bash+
+** +binutils+
+** +gcc+
+** `g++`
+** +GNU sed+
+** +GNU awk+
+** +GNU make+
+** +patch+
+** +gzip+
+** +perl+
+** +tar+
+** +wget+
+** +findutils (find, xargs)+
+** +ncurses5 development+
+** +zlib development+
+** +libc development+
+There is a check for the required versions of these tools in advance,
+though. To re-issue the checks, use +make prereq+.
+For some packages there are some optional packages required. OpenADK
+will check for the required tools in advance, when a specific package is
+choosen. For example XBMC needs java installed on the host system.
+OpenADK tries to avoid any optional required host tools and will try to
+build them when needed.
+For some host systems you can try to use ./scripts/ to
+install all required software. You need to run the script as root, it
+will use the package management of your host to install the software.