Skip to content

Commit

Permalink
Adding seperate "pages" directory for general documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mushrom committed Jun 7, 2014
1 parent 7c97551 commit 12cd0cb
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 2 deletions.
5 changes: 3 additions & 2 deletions doc/doxy.conf
Expand Up @@ -58,7 +58,7 @@ PROJECT_LOGO =
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.

OUTPUT_DIRECTORY = .
OUTPUT_DIRECTORY = ./output

# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and
Expand Down Expand Up @@ -764,7 +764,8 @@ WARN_LOGFILE =
# spaces.
# Note: If this tag is empty the current directory is searched.

INPUT = ../kernel
INPUT = ../kernel \
pages

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
Expand Down
3 changes: 3 additions & 0 deletions doc/pages/developing.md
@@ -0,0 +1,3 @@
Developing for Helix OS {#developing}
===============================
TODO: Fill this in.
33 changes: 33 additions & 0 deletions doc/pages/main.md
@@ -0,0 +1,33 @@
Helix OS {#mainpage}
========

Helix OS is a rewrite of OS-Thing from scratch, with an emphasis on simplicity and correctness.
The end goal is to be a versatile kernel which is easily modifiable by a programmer.

It currently supports:

- Module loading and linking
- Kernel multithreading
- VFS with multiple file systems
- PCI devices
- IDE disks
- VGA text mode
- FAT12 filesystem

Next steps:

- Start working on the userland
- VGA framebuffer
- TCP/IP stack
- More filesystem drivers, e.g. EXT2

After that:

- Port development tools
- Be self-hosting

Still early in development.

Developing
----------
Interested in making Helix OS better or just peeking inside? Read more about [developing](@ref developing).

0 comments on commit 12cd0cb

Please sign in to comment.