1
0
mirror of https://github.com/SerenityOS/serenity synced 2024-07-09 14:50:45 +00:00
serenity/ReadMe.md

112 lines
3.6 KiB
Markdown
Raw Normal View History

# SerenityOS
2019-02-08 10:04:23 +00:00
Graphical Unix-like operating system for x86 computers.
2019-02-08 10:04:23 +00:00
2019-05-28 15:13:28 +00:00
![Travis CI status](https://api.travis-ci.com/SerenityOS/serenity.svg?branch=master)
2019-05-28 12:47:24 +00:00
2019-02-08 10:04:23 +00:00
## 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.
2020-02-06 14:50:52 +00: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 10:04:23 +00:00
2020-02-06 14:50:52 +00:00
I (Andreas) regularly post raw hacking sessions and demos on [my YouTube channel](https://www.youtube.com/c/AndreasKling/).
2019-06-07 15:57:03 +00:00
2019-08-29 07:40:34 +00:00
Sometimes I write about the system on [my github.io blog](https://awesomekling.github.io/).
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.
## Screenshot
![Screenshot as of 1133aca](https://raw.githubusercontent.com/SerenityOS/serenity/master/Meta/screenshot-1133aca.png)
2020-02-06 14:50:52 +00:00
## Kernel features
2019-02-08 10:04:23 +00:00
2020-02-06 14:50:52 +00: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
* ext2 filesystem
2019-06-07 15:57:03 +00:00
* POSIX signals
* Purgeable memory
* /proc filesystem
* Pseudoterminals (with /dev/pts filesystem)
* Filesystem notifications
2020-02-06 14:50:52 +00:00
* CPU and memory profiling
* SoundBlaster 16 driver
2020-02-06 14:50:52 +00:00
* VMWare/QEMU mouse integration
## System services
* Launch/session daemon (SystemServer)
* Compositing window server (WindowServer)
* Text console manager (TTYServer)
2020-02-06 14:50:52 +00:00
* DNS client (LookupServer)
* Network protocols server (ProtocolServer)
2020-02-06 14:50:52 +00:00
* Software-mixing sound daemon (AudioServer)
* Desktop notifications (NotificationServer)
* HTTP server (WebServer)
* Telnet server (TelnetServer)
* DHCP client (DHCPClient)
2020-02-06 14:50:52 +00:00
## Libraries
* C++ templates and containers (AK)
* Event loop and utilities (LibCore)
* 2D graphics library (LibGfx)
* GUI toolkit (LibGUI)
* Cross-process communication library (LibIPC)
* HTML/CSS engine (LibWeb)
2020-03-14 17:03:41 +00:00
* JavaScript engine (LibJS)
2020-02-06 14:50:52 +00:00
* Markdown (LibMarkdown)
* Audio (LibAudio)
* PCI database (LibPCIDB)
* Terminal emulation (LibVT)
* Out-of-process network protocol I/O (LibProtocol)
2020-03-14 17:03:41 +00:00
* Mathematical functions (LibM)
* ELF file handing (LibELF)
* POSIX threading (LibPthread)
* Higher-level threading (LibThread)
* Transport Layer Security (LibTLS)
* HTTP and HTTPS (LibHTTP)
2020-02-06 14:50:52 +00: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)
* IRC client
2020-02-06 14:50:52 +00:00
* Desktop synthesizer (Piano)
* Various desktop apps & games
* Color themes
2019-02-08 10:04:23 +00:00
## How do I build and run this?
2019-12-29 15:25:06 +00:00
See the [SerenityOS build instructions](https://github.com/SerenityOS/serenity/blob/master/Documentation/BuildInstructions.md)
## Before opening an issue
Please see the [issue policy](https://github.com/SerenityOS/serenity/blob/master/CONTRIBUTING.md#issue-policy).
2020-02-06 14:50:52 +00:00
## Wanna chat?
2020-02-06 14:50:52 +00:00
Come hang out with us in `#serenityos` on the Freenode IRC network.
2019-02-08 10:04:23 +00:00
## Author
2019-06-07 15:57:03 +00:00
* **Andreas Kling** - [awesomekling](https://twitter.com/awesomekling)
## Contributors
* **Robin Burchell** - [rburchell](https://github.com/rburchell)
2019-09-18 10:15:02 +00:00
* **Conrad Pankoff** - [deoxxa](https://github.com/deoxxa)
* **Sergey Bugaev** - [bugaevc](https://github.com/bugaevc)
* **Liav A** - [supercomputer7](https://github.com/supercomputer7)
2019-02-08 10:04:23 +00:00
2019-09-18 10:15:02 +00:00
(And many more!) Feel free to append yourself here if you've made some sweet contributions. :)
2019-06-07 15:57:03 +00:00
2019-02-08 10:04:23 +00:00
## License
SerenityOS is licensed under a 2-clause BSD license.