Fixed some bugs after merge;
[ZeXOS.git] / INSTALL
blob5371db463ba2faed8bf167a303c1dc04a8478744
1 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
3              INSTALL howto for ZeX/OS
5 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
7 * For users *
9 1. You need to get some burning program
10 2. In menu select something like 'burn image cd'
11 3. Find file zexos-*-i386.iso (http://zexos.org/package/) and check it
12 4. Burn ZeX/OS image
13 5. Reboot your computer (need to set in BIOS booting from cd)
14 6. When you see on the screen ZeX/OS title, press enter
15 7. Have fun !
17 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
19 * User app installation *
21 See README file ...
23 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
25 * For developers *
27 1. You have to install git, nasm, gcc, make
28 2. Then you can download source code by: git clone git://repo.or.cz/ZeXOS.git
29 3. Now move to source directory: cd ZeXOS
30 3. Lets compile whole OS and create *.iso : ./build.sh iso
31    or make *.img image                    : ./build.sh img
32    or install to floppy                   : ./build.sh floppy
33 4. Last step, you'll need burn this image, start it under virtual machine or use floppy, e.g.
34    for starting in Qemu just enter        : ./build.sh qemu
35 5. Have a lot of fun !
37 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
39 * Multiplatform howto *
41 Available architectures: i386, x86_64, arm
43 1. For compilation on ARM platform start: ARCH=arm ./build.sh
44 2. When all was finished succefully, you can run it under virtual machine, e.g. Qemu.
45    You'll need installed program qemu-system-arm, then start: ARCH=arm ./build.sh qemu  
47 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
49 * More docs *
51 ZeX/OS wiki pages at http://zexos.wiki.sourceforge.net/FAQ
52 Forum is placed at http://forum.zexos.org
54 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
56 * Utilities *
58 Kernel configure:
59 1. Go to kernel source directory, probably it is "kernel": cd kernel
60 2. Now you have to type for base-textual config: make config
61                         for QT-based GUI config: make xconfig
62                         for GTKbased GUI config: make gconfig
64 NOTE: You'll need to clean source when you have compiled it: make clean
65         Now you can configure your kernel and then recompile it: make
67 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-