2019-12-29 18:23:50 +03:00
# SerenityOS
2019-02-08 13:04:23 +03:00
2019-04-15 15:16:45 +03:00
Graphical Unix-like operating system for x86 computers.
2019-02-08 13:04:23 +03:00
2020-11-07 18:54:27 +03:00
[![Build status ](https://github.com/SerenityOS/serenity/workflows/Build,%20lint,%20and%20test/badge.svg )](https://github.com/SerenityOS/serenity/actions?query=workflow%3A"Build%2C%20lint%2C%20and%20test")
2020-11-29 14:24:00 +03:00
[![Fuzzing Status ](https://oss-fuzz-build-logs.storage.googleapis.com/badges/serenity.svg )](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened& can=1& q=proj:serenity)
2021-06-15 00:23:12 +03:00
[![Discord ](https://img.shields.io/discord/830522505605283862.svg?logo=discord&logoColor=white&logoWidth=20&labelColor=7289DA&label=Discord&color=17cf48 )](https://discord.gg/serenityos)
2019-05-28 15:47:24 +03:00
2019-02-08 13:04:23 +03:00
## About
2019-12-29 18:23:50 +03:00
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.
2019-03-20 17:52:37 +03:00
2020-02-06 17:50:52 +03:00
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.
2019-02-08 13:04:23 +03:00
2020-02-06 17:50:52 +03:00
I (Andreas) regularly post raw hacking sessions and demos on [my YouTube channel ](https://www.youtube.com/c/AndreasKling/ ).
2019-06-07 18:57:03 +03:00
2019-08-29 10:40:34 +03:00
Sometimes I write about the system on [my github.io blog ](https://awesomekling.github.io/ ).
2019-04-15 15:16:45 +03:00
2019-12-29 18:23:50 +03:00
I'm also on [Patreon ](https://www.patreon.com/serenityos ) and [GitHub Sponsors ](https://github.com/sponsors/awesomekling ) if you would like to show some support that way.
2019-04-15 15:16:45 +03:00
2019-02-12 17:47:37 +03:00
## Screenshot
2021-04-04 10:57:36 +03:00
![Screenshot as of 0f85753.png ](https://raw.githubusercontent.com/SerenityOS/serenity/master/Meta/screenshot-0f85753.png )
2019-02-12 17:47:37 +03:00
2020-02-06 17:50:52 +03:00
## Kernel features
2019-02-08 13:04:23 +03:00
2020-02-06 17:50:52 +03:00
* x86 (32-bit) kernel with pre-emptive multi-threading
* Hardware protections (SMEP, SMAP, UMIP, NX, WP, TSD, ...)
* IPv4 stack with ARP, TCP, UDP and ICMP protocols
2019-02-27 15:17:43 +03:00
* ext2 filesystem
2019-06-07 18:57:03 +03:00
* POSIX signals
2019-12-29 18:23:50 +03:00
* Purgeable memory
2019-02-27 15:17:43 +03:00
* /proc filesystem
2019-04-30 16:27:35 +03:00
* Pseudoterminals (with /dev/pts filesystem)
2019-08-05 17:26:39 +03:00
* Filesystem notifications
2020-02-06 17:50:52 +03:00
* CPU and memory profiling
2019-08-05 17:26:39 +03:00
* SoundBlaster 16 driver
2020-02-06 17:50:52 +03:00
* VMWare/QEMU mouse integration
## System services
* Launch/session daemon (SystemServer)
* Compositing window server (WindowServer)
2020-03-14 20:03:20 +03:00
* Text console manager (TTYServer)
2020-02-06 17:50:52 +03:00
* DNS client (LookupServer)
2021-04-23 23:45:52 +03:00
* Network protocols server (RequestServer and WebSocket)
2020-02-06 17:50:52 +03:00
* Software-mixing sound daemon (AudioServer)
2020-03-14 20:03:20 +03:00
* Desktop notifications (NotificationServer)
* HTTP server (WebServer)
* Telnet server (TelnetServer)
2020-05-09 10:50:49 +03:00
* DHCP client (DHCPClient)
2020-02-06 17:50:52 +03:00
## Libraries
* C++ templates and containers (AK)
* Event loop and utilities (LibCore)
* 2D graphics library (LibGfx)
2021-05-28 19:47:38 +03:00
* OpenGL 1.x compatible library (LibGL)
2020-02-06 17:50:52 +03:00
* GUI toolkit (LibGUI)
* Cross-process communication library (LibIPC)
2020-03-07 12:32:51 +03:00
* HTML/CSS engine (LibWeb)
2020-03-14 20:03:41 +03:00
* JavaScript engine (LibJS)
2020-02-06 17:50:52 +03:00
* Markdown (LibMarkdown)
* Audio (LibAudio)
* PCI database (LibPCIDB)
* Terminal emulation (LibVT)
2020-05-09 10:50:49 +03:00
* Out-of-process network protocol I/O (LibProtocol)
2020-03-14 20:03:41 +03:00
* Mathematical functions (LibM)
2020-09-01 14:49:16 +03:00
* ELF file handling (LibELF)
2020-03-14 20:03:41 +03:00
* POSIX threading (LibPthread)
2021-05-22 19:47:42 +03:00
* Higher-level threading (LibThreading)
2020-05-09 10:50:49 +03:00
* Transport Layer Security (LibTLS)
* HTTP and HTTPS (LibHTTP)
2021-07-24 01:11:08 +03:00
* IMAP (LibIMAP)
2020-02-06 17:50:52 +03:00
## Userland features
* Unix-like libc and userland
* Shell with pipes and I/O redirection
* On-line help system (both terminal and GUI variants)
* Web browser (Browser)
* C++ IDE (HackStudio)
2019-03-20 17:52:37 +03:00
* IRC client
2020-02-06 17:50:52 +03:00
* Desktop synthesizer (Piano)
2021-07-24 01:11:08 +03:00
* E-mail client (Mail)
2020-02-06 17:50:52 +03:00
* Various desktop apps & games
* Color themes
2019-02-08 13:04:23 +03:00
2020-05-26 14:12:25 +03:00
## How do I read the documentation?
2021-05-04 23:52:46 +03:00
Man pages are available online at [man.serenityos.org ](https://man.serenityos.org ). These pages are generated from the Markdown source files in [`Base/usr/share/man` ](https://github.com/SerenityOS/serenity/tree/master/Base/usr/share/man ) and updated automatically.
2020-05-26 14:12:25 +03:00
2021-04-26 00:49:54 +03:00
When running SerenityOS you can use `man` for the terminal interface, or `help` for the GUI.
2020-05-26 14:12:25 +03:00
2019-03-20 17:52:37 +03:00
## How do I build and run this?
2019-02-17 11:45:39 +03:00
2019-12-29 18:25:06 +03:00
See the [SerenityOS build instructions ](https://github.com/SerenityOS/serenity/blob/master/Documentation/BuildInstructions.md )
2019-12-29 18:23:50 +03:00
2020-05-09 10:50:49 +03:00
## Before opening an issue
Please see the [issue policy ](https://github.com/SerenityOS/serenity/blob/master/CONTRIBUTING.md#issue-policy ).
2021-05-09 10:15:56 +03:00
FAQ: [Frequently Asked Questions ](https://github.com/SerenityOS/serenity/blob/master/Documentation/FAQ.md )
2021-05-05 21:03:02 +03:00
2021-04-09 16:24:15 +03:00
## Get in touch
2019-12-29 18:23:50 +03:00
2021-06-15 00:23:12 +03:00
Join our Discord server: [SerenityOS Discord ](https://discord.gg/serenityos )
2021-04-11 23:04:13 +03:00
2019-02-08 13:04:23 +03:00
## Author
2019-06-07 18:57:03 +03:00
* **Andreas Kling** - [awesomekling ](https://twitter.com/awesomekling )
## Contributors
2019-05-26 02:25:42 +03:00
* **Robin Burchell** - [rburchell ](https://github.com/rburchell )
2019-09-18 13:15:02 +03:00
* **Conrad Pankoff** - [deoxxa ](https://github.com/deoxxa )
* **Sergey Bugaev** - [bugaevc ](https://github.com/bugaevc )
2020-04-10 14:55:33 +03:00
* **Liav A** - [supercomputer7 ](https://github.com/supercomputer7 )
2020-05-17 14:13:40 +03:00
* **Linus Groh** - [linusg ](https://github.com/linusg )
* **Ali Mohammad Pur** - [alimpfard ](https://github.com/alimpfard )
* **Shannon Booth** - [shannonbooth ](https://github.com/shannonbooth )
2020-06-23 20:34:11 +03:00
* **Hüseyin ASLITÜRK** - [asliturk ](https://github.com/asliturk )
2020-07-25 16:22:23 +03:00
* **Matthew Olsson** - [mattco98 ](https://github.com/mattco98 )
2020-08-03 19:37:08 +03:00
* **Nico Weber** - [nico ](https://github.com/nico )
2020-08-05 23:06:31 +03:00
* **Brian Gianforcaro** - [bgianfo ](https://github.com/bgianfo )
2020-08-12 21:51:47 +03:00
* **Ben Wiederhake** - [BenWiederhake ](https://github.com/BenWiederhake )
2020-08-21 16:04:27 +03:00
* **Tom** - [tomuta ](https://github.com/tomuta )
2020-09-14 22:17:12 +03:00
* **Paul Scharnofske** - [asynts ](https://github.com/asynts )
2020-09-20 20:55:36 +03:00
* **Itamar Shenhar** - [itamar8910 ](https://github.com/itamar8910 )
2020-12-12 01:29:30 +03:00
* **Luke Wilde** - [Lubrsi ](https://github.com/Lubrsi )
2020-12-24 12:47:36 +03:00
* **Brendan Coles** - [bcoles ](https://github.com/bcoles )
2021-01-13 13:26:16 +03:00
* **Andrew Kaster** - [ADKaster ](https://github.com/ADKaster )
2021-03-30 11:52:21 +03:00
* **thankyouverycool** - [thankyouverycool ](https://github.com/thankyouverycool )
2021-04-17 12:25:22 +03:00
* **Idan Horowitz** - [IdanHo ](https://github.com/IdanHo )
2021-04-18 12:33:03 +03:00
* **Gunnar Beutner** - [gunnarbeutner ](https://github.com/gunnarbeutner )
2021-04-24 15:34:18 +03:00
* **Tim Flynn** - [trflynn89 ](https://github.com/trflynn89 )
2021-05-24 14:33:52 +03:00
* **Jean-Baptiste Boric** - [boricj ](https://github.com/boricj )
2021-05-24 22:05:49 +03:00
* **Stephan Unverwerth** - [sunverwerth ](https://github.com/sunverwerth )
2021-06-11 13:47:08 +03:00
* **Max Wipfli** - [MaxWipfli ](https://github.com/MaxWipfli )
2021-07-08 11:38:32 +03:00
* **Daniel Bertalan** - [BertalanD ](https://github.com/BertalanD )
2021-07-31 12:21:06 +03:00
* **Jelle Raaijmakers** - [GMTA ](https://github.com/GMTA )
2021-07-31 12:22:28 +03:00
* **Sam Atkins** - [AtkinsSJ ](http://github.com/AtkinsSJ )
2019-02-08 13:04:23 +03:00
2020-05-17 14:13:40 +03:00
(And many more!) The people listed above have landed more than 100 commits in the project. :^)
2019-06-07 18:57:03 +03:00
2019-02-08 13:04:23 +03:00
## License
2019-12-29 18:23:50 +03:00
SerenityOS is licensed under a 2-clause BSD license.