README

Getting started:
================

tachyon3 is a pure x86_64 kernel, no 32bit support (anymore)!

to be able to build tachyon, you will at least need matching
binutils and a compiler. any more or less resent (>4.0) gcc
should do, and any binutils working with it.

A build script for the toolchain is provided, which builds the
currently tested and used (by the developer(s)) versions of the
required packages. Take a look at ./tools/toolchain.sh --help
for information on how to use it. 

On ... some ... systems, you will have to make sure to install
those before building will succeed (tested on ubuntu 13.10):

    apt-get install ncurses-dev
    apt-get install libreadline-dev
    apt-get install libz-dev
    apt-get install autoconf
    apt-get install libpixman-1-dev
    apt-get install libxrandr-dev
    apt-get install libgtk-3-dev
    apt-get install bison flex texinfo help2man bc gettext
    apt-get install ninja-build

On Fedora, etc.:

    dnf install ncurses-devel readline-devel zlib-devel \
        autoconf pixman-devel libXrandr-devel \
        gcc gcc-c++ texinfo flex bison help2man glib2-devel \
        ninja-build gtk3-devel

Prepare the toolchain by running:

    ./tools/toolchain.sh -v -j 3 --preflight --download

Now you can do this in the source tachyon root directory:

    make                    # build default arch (x86_64)
    make clean              # remove build directory (removes all
                              generated files, iso images, etc.
    make iso                # build iso image for the current ARCH
    
    make qemu               # run kernel directly in qemu (must be installed)
    make qemu-dbg           # same as above, but run GDB remote stub on :1234
    make gdb                # attach a debugger to the above debugable qemu

    make qemu-netboot       # netboot with qemu builtin ROM, needs qemu with gPXE ROM
    make qemu-netboot-dbg   # same as above, attach debugger with make gdb
    make qemu-netboot-grub2 # use GRUB2 (must be installed) to netboot.
    make qemu-netboot-grub2-dbg # same as above, debug with make gdb
    make qemu-cd            # boot kernel from GRUB2 cd.
    make qemu-cd-dbg        # same as above but with debugger, run make gdb to debug

    make bochs-cd           # boot with bochs from GRUB2 cd (bochs must be installed)

To build the documentation, you need doxygen installed on the
host. Simply call "doxygen" in the top-level source dir, which
will create the documentation in the .doc subdirectory.