serenity README

The project's README from github.com/SerenityOS/serenity. As one markdown file: README.md.

SerenityOS

Graphical Unix-like operating system for 64-bit x86, Arm, and RISC-V computers.

GitHub Actions Status Fuzzing Status Discord

FAQ | Documentation | Build Instructions

About

SerenityOS 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 us, for us, based on the things we like.

You can watch videos of the system being developed on YouTube:

Screenshot

Screenshot as of c03b788.png

Features

... and all of the above are right in this repository, no extra dependencies, built from-scratch by us :^)

Additionally, there are over three hundred ports of popular open-source software, including games, compilers, Unix tools, multimedia apps and more.

How do I read the documentation?

Man pages are available online at man.serenityos.org. These pages are generated from the Markdown source files in Base/usr/share/man and updated automatically.

When running SerenityOS you can use man for the terminal interface, or help for the GUI.

Code-related documentation can be found in the documentation folder.

How do I build and run this?

See the SerenityOS build instructions or the Ladybird build instructions.

The build system supports a cross-compilation build of SerenityOS from Linux, macOS, Windows (with WSL2) and many other *Nixes. The default build system commands will launch a QEMU instance running the OS with hardware or software virtualization enabled as supported.

Ladybird runs on the same platforms that can be the host for a cross build of SerenityOS and on SerenityOS itself.

Get in touch and participate!

Join our Discord server: SerenityOS Discord

Before opening an issue, please see the issue policy.

A general guide for contributing can be found in CONTRIBUTING.md.

Authors

And many more! See here for a full contributor list. The people listed above have landed more than 100 commits in the project. :^)

License

SerenityOS is licensed under a 2-clause BSD license.

serenity (SerenityOS/serenity)

Searching Database…

33.9K ·GitHub
What is this?SerenityOS is a graphical Unix-like operating system for 64-bit x86, Arm, and RISC-V computers, built entirely from scratch.
Is it a complete system with a desktop and apps, or just a kernel?A complete OS, not just a kernel: a custom Unix-like core with a GUI, browser, IDE, games, dev tools and 300+ ports of open-source software, all in this one repository with no extra dependencies.
How do I build and run it?Cross-compile it from Linux, macOS, Windows (with WSL2) or other Unixes following the build instructions; the default build commands then launch a QEMU instance running the OS.
Is it ready to use as an everyday operating system?It is a passion project in active development rather than a production daily driver; the README even points to YouTube videos of the system being built. It already ships a full desktop, browser, IDE and 300+ ports.
Why does it look the way it does — what is the design goal?A marriage of late-1990s productivity software aesthetics with the power-user accessibility of late-2000s Unix, made by and for the people who like those things.
Does it run on real hardware, or only in an emulator?It targets real 64-bit x86, Arm and RISC-V computers, but the standard way to try it is the QEMU instance that the default build launches automatically, with hardware or software virtualization.
What applications come with it out of the box?Everyday GUI apps like a JavaScript-powered Spreadsheet, TextEditor, Terminal, PixelPaint, Mail, Assistant and Calculator, plus games such as Solitaire, Minesweeper, 2048 and chess, and demos like CatDog and Starfield.
How capable is the built-in browser?It has its own browser engine with JavaScript and WebAssembly support, and the project tracks spec compliance for JS, CSS and Wasm. The browser, Ladybird, also runs on the cross-build host platforms, not just inside SerenityOS.
What security features does it include?Hardware protections, limited userland capabilities, W^X memory, pledge and unveil, (K)ASLR, OOM-resistance, web-content isolation and state-of-the-art TLS algorithms.
Does it come with developer tools built in?Yes — HackStudio, an IDE for C++, plus kernel-supported profiling, CrashReporter, HexEditor, an interactive GUI playground, and man pages readable via man in the terminal or help in the GUI.
What are similar projects?lytlnyblOS, redox, darwin-xnu, daedalOS, zephyr, SFML, puter, src
Creator
SerenityOS
Size
238.2 MB
Stars
33.9K
Updated
CommitOct 16
Age
7y
Commits · 90 Days