The goal of this wiki is to modernize the information found in the long-standing OSDev wiki found at wiki.osdev.org and to decentralize it. It is currently WIP and not ready for use.
This wiki is not endorsed by, does not have any connection to, and is not related in any way with another wiki found at wiki.osdev.org.
This wiki is written in Haskell.
The project has some non-Haskell dependencies:
- Pygments -
pip install Pygments - AsciiDoctor -
gem install asciidoctor - asciidoctor-bibtex -
gem install asciidoctor-bibtex - stork -
cargo install stork-search --locked
Because building the Haskell dependecies takes a long time, we recommend using our Nix binary cache to get all the dependecies without building. (~10 min setup time)
Edit the configuration file added by Nix at /etc/nix/nix.conf and add these two lines to setup the binary cache:
trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= hydra.iohk.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ= osdev-wiki-cache-2:xnfH8Tkm0Sp5c8dDxpuFE0/w1PB6E4NUxjcnShNdkZ0=
substituters = https://cache.nixos.org/ https://hydra.iohk.io s3://osdev-wiki-cache?scheme=https&endpoint=s3.us-west-000.backblazeb2.comFrom the root of the project, build:
cd generator
nix-buildRun the generator:
cd ..
./generator/result/bin/generator watchAlternatively, you can build locally (~1 hour build time). You do not need to do this if you have done the Nix setup above.
You will need to have Stack installed to compile and run the main binary.
From the root of the project, run:
cd generator
stack buildRun the generator:
stack run --cwd .. watchAll content can be found in pages/. You can find our quick guide here to learn the basics (~2 min reading).