Skip to content
Serenity Operating System
C++ C Shell Makefile HTML Visual Basic Other
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Meta: Add funding links to get a "Sponsor" button on GitHub Aug 25, 2019
AK UTF-8: Add Utf8CodepointIterator::codepoint_length_in_bytes() Oct 18, 2019
Applications Browser: Add basic back/forward history Oct 17, 2019
Base LibHTML: Implement basic tiled background image support Oct 19, 2019
Demos Demos: Remove useless PaintTest program Sep 29, 2019
DevTools AK: Remove empty files JsonArray.cpp and JsonObject.cpp Oct 1, 2019
Documentation Documentation: Let's have a coding style document Aug 21, 2019
Games LibCore: Remove ObjectPtr in favor of RefPtr Sep 21, 2019
Kernel Net: Put a bunch of socket debug logging behind FOO_DEBUG Oct 18, 2019
Lagom Lagom: Fix TestApp to build after the CObject ref-counting changes Oct 7, 2019
Libraries LibHTML: Use the correct inherited color for LayoutListItemMarker Oct 19, 2019
Meta Meta: Tweak the Qt Creator project updater a bit Sep 28, 2019
Ports Ports: libarchive Oct 13, 2019
Servers LibDraw: Rename Painter::blit_tiled() => draw_tiled_bitmap() Oct 19, 2019
Shell ByteBuffer: Remove pointer() in favor of data() Sep 30, 2019
Toolchain Toolchain/BuildIt.sh: Use curl instead of wget Sep 26, 2019
Userland LibHTML: Rename Document::normalize() to fixup() and always do it Oct 9, 2019
.clang-format Meta: Tweak .clang-format to not wrap braces after enums. Jun 7, 2019
.gitignore Ports: Switch to new ports system (#594) Sep 24, 2019
.travis.yml Meta: Let's try giving Travis some valid YAML this time.. Sep 4, 2019
Contributing.md Meta: Add note about the first line of commit messages to contrib guide Aug 25, 2019
INSTALL.md Meta: Add instructions for debugging boot issues via serial console f… Sep 27, 2019
LICENSE Let's go with a 2-clause BSD license. Apr 15, 2019
Makefile.common Build: Add LibMarkdown to the library search path Oct 3, 2019
ReadMe.md Meta: Fix some typos in ReadMe.md (#671) Oct 18, 2019

ReadMe.md

Serenity

Graphical Unix-like operating system for x86 computers.

Travis CI status

About

I always wondered what it would be like to write my own operating system, but I never took it seriously. Until now.

Serenity is a love letter to '90s user interfaces with a custom Unix-like core. It flatters with sincerity by stealing beautiful ideas from various other systems.

Roughly speaking, the goal is a marriage between the aesthetic of late-1990s productivity software and the power-user accessibility of late-2000s *nix. This is a system by me, for me, based on the things I like.

If you like some of the same things, you are welcome to join the project. It would be great to one day change the above to say "this is a system by us, for us, based on the things we like." :^)

I regularly post raw hacking sessions and demos on my YouTube channel.

Sometimes I write about the system on my github.io blog.

There's also a Patreon if you would like to show some support that way.

Screenshot

Screenshot as of 9145a72

Current features

  • Pre-emptive multitasking
  • Multithreading
  • Compositing window server
  • IPv4 networking with ARP, TCP, UDP and ICMP
  • ext2 filesystem
  • Unix-like libc and userland
  • POSIX signals
  • Shell with pipes and I/O redirection
  • mmap()
  • /proc filesystem
  • Local sockets
  • Pseudoterminals (with /dev/pts filesystem)
  • Filesystem notifications
  • JSON framework
  • Low-level utility library (LibCore)
  • Mid-level 2D graphics library (LibDraw)
  • High-level GUI library (LibGUI)
  • Emojis (UTF-8)
  • HTTP downloads
  • SoundBlaster 16 driver
  • Software-mixing sound daemon
  • WAV playback
  • Simple desktop piano/synthesizer
  • Visual GUI design tool
  • PNG format support
  • Text editor
  • IRC client
  • Simple painting application
  • DNS lookup
  • Desktop games: Minesweeper and Snake
  • Ports system (needs more packages!)
  • Other stuff I can't think of right now...

How do I build and run this?

Make sure you have all the dependencies installed:

sudo apt install build-essential curl libmpfr-dev libmpc-dev libgmp-dev e2fsprogs qemu-system-i386 qemu-utils

Ensure your gcc version is >= 8 with gcc --version. Otherwise, install it (on Ubuntu) with:

sudo add-apt-repository ppa:ubuntu-toolchain-r/test
sudo apt-get install gcc-8 g++-8
sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-8 800 --slave /usr/bin/g++ g++ /usr/bin/g++-8

Go into the Toolchain/ directory and run the BuildIt.sh script. Then source the UseIt.sh script to put the i686-pc-serenity toolchain in your $PATH.

Once you've done both of those, go into the Kernel/ directory, then run ./makeall.sh, and if nothing breaks too much, take it for a spin by using ./run.

You can vastly reduce the build time of successive rebuilds of Serenity by installing ccache and exporting PRE_CXX=ccache

Bare curious users may even consider sourcing suitable hardware to install Serenity on a physical PC.

Later on, when you git pull to get the latest changes, there's no need to rebuild the toolchain. You can simply rerun ./makeall.sh in the Kernel/ directory and you'll be good to ./run again.

Notes on WSL

SerenityOS can also be built and run under WSL Version 2. WSL Version 1 is not supported since Version 1 does not support ext2, which is needed for the setup.

WSL Version 2 is currently only available for Insider Builds of Windows which are more unstable and prone to crashes. Therefore, running SerenityOS on WSL Version 2 and running Insider Builds, in general, is not recommended on production systems.

Nevertheless, here is a guide on how to get an Insider Build and how to get WSL2. The installation then proceeds as usual.

WSL2 does not natively support graphical applications. This means that to actually ./run SerenityOS, you need an X Server for windows. Vcxsrv is a good option. When you start up Vcxsrv, make sure to set the Display number to 0, and to Disable access control. Before actually doing ./run, you need to set the DISPLAY environmental variable as such:

export DISPLAY=$(cat /etc/resolv.conf | grep nameserver | awk '{print $2}'):0

This is due to a bug in WSL2. For more information, microsoft/WSL#4106.

Now you can finally, ./run.

IRC

Come chat in #serenityos on the Freenode IRC network.

Author

Contributors

(And many more!) Feel free to append yourself here if you've made some sweet contributions. :)

License

Serenity is licensed under a 2-clause BSD license.

You can’t perform that action at this time.