JehanneOS/jehanne
JehanneOS
/
jehanne
1
0
Fork 0
Code Issues Pull Requests Projects Releases Activity
Jehanne Operating System http://jehanne.h--k.it
4 Commits 1 Branch 0 Tags 9.7 MiB
C 97.5%
Shell 1.1%
Assembly 0.8%
Yacc 0.6%
Go to file
Giacomo Tesio b5fcad4e29 Add devtools (as submodule) in hacking/ 2015-12-22 10:38:12 +00:00
doc/license Add LICENCE.md and doc/license 2015-12-22 10:31:50 +00:00
hacking@0f953617d1 Add devtools (as submodule) in hacking/ 2015-12-22 10:38:12 +00:00
.gitmodules Add devtools (as submodule) in hacking/ 2015-12-22 10:38:12 +00:00
LICENSE.md Add LICENCE.md and doc/license 2015-12-22 10:31:50 +00:00
README.md README.md: expand overview 2015-12-22 10:33:57 +00:00

README.md

Build Status

Jehanne

Jehanne is a simple operating system.

It is a fork of Harvey (which in turn is a fork of Plan 9 from Bell Labs merged with Nix sources) but diverges from the design and conventions of its ancestors whenever they are at odds with its goals.

For this reason the project is named after the famous Franch heretic Joan of Arc.

Overview

This is the main repository, used to build the system as a whole:

  • arch contains one folder for each supported architecture, with specific C headers and binaries
  • sys is the system folder
    • include contains portable C headers
    • lib contains data and scripts used by the running system
    • man contains manual pages
    • src contains the sources of the system
  • doc contains useful documentation for Jehanne development
    • license contains detailed info about Jehanne licenses
    • hacking contains details about how to build and modify Jehanne
  • hacking contains the utilities used to develop Jehanne
  • qa contains the regression tests
  • mnt contains default mount targets
  • usr contains the users' folders
  • pkgs will contains the installed packages

The running system also includes supplemental folders like /lib, /bin and /dev that are bound during the boot as required.

Build

To build Jehanne and play with it, you need to have git, golang, qemu, gcc, binutils and bison installed. For example on Debian GNU/Linux you should be able to get going with

sudo aptitude install git golang build-essential bison qemu-system

After the repository clone, you can give a look with

git submodule init			# we have a lot of submodules
git submodule update --init --recursive
./hacking/devshell.sh			# start a shell with appropriate environment
./hacking/continuous-build.sh		# to build everything
./hacking/runOver9P.sh			# to start the system in QEMU
./hacking/drawterm.sh			# to connect Jehanne with drawterm

Hacking

Jehanne is a work in progress. Forks and pull requests are welcome.

In doc/hacking you will find all you need to know about its principles, design and weirdness.

There's a lot of work to do, in every area of the system.

To coordinate our efforts, we use the github issues. To discuss (and even debate) about the design and development of Jehanne we use the JehanneOS mailing list: please join and present yourself and your attitudes.