README.md

A highly experimental OS written in Crystal.
Chat with us on Discord!

Contributing

If you want to help, talk to us on our Discord server.
We'll be happy to work with you.

Building on Linux/WSL

• Get an i686-elf gcc cross-compiler going
• Install the latest Crystal compiler
• Install the latest version of SCons
• Run scons to build
• Run scons test to run Runtime tests.
• Run scons --qemu-curses to build and run qemu

Building via Docker

• Build the Docker image: docker build -t fluorite-builder .

• Use the image to compile the code: docker run --rm -v $(pwd):/build -t fluorite-builder

• Any arguments to scons can be passed in like this: docker run --rm -v $(pwd):/build -t fluorite-builder -- test <- runs scons test within the container.

• all build artifacts will be placed in the ./build directory

Troubleshooting

xorriso : FAILURE : Cannot find path '/efi.img' in loaded ISO image or
grub-mkrescue: error: ``mformat`` invocation failed:

• On Arch: sudo pacman -Sy mtools
• On Debian/Ubuntu/WSL: sudo apt-get install mtools
• On Fedora/RedHat/CentOS: sudo yum install mtools