ladybird/ReadMe.md

# SerenityOS

Graphical Unix-like operating system for x86 computers.

![Travis CI status](https://api.travis-ci.com/SerenityOS/serenity.svg?branch=master)

## 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.

I (Andreas) regularly post raw hacking sessions and demos on [my YouTube channel](https://www.youtube.com/c/AndreasKling/).

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 8ea4375](https://raw.githubusercontent.com/SerenityOS/serenity/master/Meta/screenshot-8ea4375.png)

## Kernel features

* 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
* POSIX signals
* Purgeable memory
* /proc filesystem
* Pseudoterminals (with /dev/pts filesystem)
* Filesystem notifications
* CPU and memory profiling
* SoundBlaster 16 driver
* VMWare/QEMU mouse integration

## System services

* Launch/session daemon (SystemServer)
* Compositing window server (WindowServer)
* Text console manager (TTYServer)
* DNS client (LookupServer)
* Network protocols server (ProtocolServer)
* Software-mixing sound daemon (AudioServer)
* Desktop notifications (NotificationServer)
* HTTP server (WebServer)
* Telnet server (TelnetServer)
* DHCP client (DHCPClient)

## 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)
* JavaScript engine (LibJS)
* Markdown (LibMarkdown)
* Audio (LibAudio)
* PCI database (LibPCIDB)
* Terminal emulation (LibVT)
* Out-of-process network protocol I/O (LibProtocol)
* Mathematical functions (LibM)
* ELF file handing (LibELF)
* POSIX threading (LibPthread)
* Higher-level threading (LibThread)
* Transport Layer Security (LibTLS)
* HTTP and HTTPS (LibHTTP)

## 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
* Desktop synthesizer (Piano)
* Various desktop apps & games
* Color themes

## How do I read the documentation?

Man pages are browsable outside of SerenityOS under [Base/usr/share/man](https://github.com/SerenityOS/serenity/tree/master/Base/usr/share/man).

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

## How do I build and run this?

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).

## Communication hubs

The main hub is `#serenityos` on the Freenode IRC network.

We also have a project mailing list: [serenityos-dev](https://lists.sr.ht/~awesomekling/serenityos-dev).

## Author

* **Andreas Kling** - [awesomekling](https://twitter.com/awesomekling)

## Contributors

* **Robin Burchell** - [rburchell](https://github.com/rburchell)
* **Conrad Pankoff** - [deoxxa](https://github.com/deoxxa)
* **Sergey Bugaev** - [bugaevc](https://github.com/bugaevc)
* **Liav A** - [supercomputer7](https://github.com/supercomputer7)
* **Linus Groh** - [linusg](https://github.com/linusg)
* **Ali Mohammad Pur** - [alimpfard](https://github.com/alimpfard)
* **Shannon Booth** - [shannonbooth](https://github.com/shannonbooth)
* **Hüseyin ASLITÜRK** - [asliturk](https://github.com/asliturk)
* **Matthew Olsson** - [mattco98](https://github.com/mattco98)
* **Nico Weber** - [nico](https://github.com/nico)
* **Brian Gianforcaro** - [bgianfo](https://github.com/bgianfo)
* **Ben Wiederhake** - [BenWiederhake](https://github.com/BenWiederhake)
* **Tom** - [tomuta](https://github.com/tomuta)

(And many more!) The people listed above have landed more than 100 commits in the project. :^)

## License

SerenityOS is licensed under a 2-clause BSD license.
Meta: Update ReadMe and move build instructions to a separate document 2019-12-29 15:23:50 +00:00			`# SerenityOS`
Add a little ReadMe. 2019-02-08 10:04:23 +00:00
Meta: Update ReadMe with license and links. 2019-04-15 12:16:45 +00:00			`Graphical Unix-like operating system for x86 computers.`
Add a little ReadMe. 2019-02-08 10:04:23 +00:00
Fix badge hopefully. 2019-05-28 15:13:28 +00:00			`![Travis CI status](https://api.travis-ci.com/SerenityOS/serenity.svg?branch=master)`
Add .travis.yml 2019-05-28 12:47:24 +00:00
Add a little ReadMe. 2019-02-08 10:04:23 +00:00			`## About`

Meta: Update ReadMe and move build instructions to a separate document 2019-12-29 15:23:50 +00: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.`
Meta: Tweak ReadMe and add a new screenshot. 2019-03-20 14:52:37 +00:00
Meta: Edit the ReadMe a little bit :^) 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.`
Add a little ReadMe. 2019-02-08 10:04:23 +00:00
Meta: Edit the ReadMe a little bit :^) 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/).`
Meta: Tweak ReadMe. 2019-06-07 15:57:03 +00:00
Meta: Fix typo in ReadMe 2019-08-29 07:40:34 +00:00			`Sometimes I write about the system on [my github.io blog](https://awesomekling.github.io/).`
Meta: Update ReadMe with license and links. 2019-04-15 12:16:45 +00:00
Meta: Update ReadMe and move build instructions to a separate document 2019-12-29 15:23:50 +00: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.`
Meta: Update ReadMe with license and links. 2019-04-15 12:16:45 +00:00
Meta: Update ReadMe with a new screenshot. :^) 2019-02-12 14:47:37 +00:00			`## Screenshot`

Meta: Time for a new screenshot! :^) This one is pretty similar to the previous one, but the increase in polish is noticeable. 2020-06-02 17:28:08 +00:00			`![Screenshot as of 8ea4375](https://raw.githubusercontent.com/SerenityOS/serenity/master/Meta/screenshot-8ea4375.png)`
Meta: Update ReadMe with a new screenshot. :^) 2019-02-12 14:47:37 +00:00
Meta: Edit the ReadMe a little bit :^) 2020-02-06 14:50:52 +00:00			`## Kernel features`
Add a little ReadMe. 2019-02-08 10:04:23 +00:00
Meta: Edit the ReadMe a little bit :^) 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`
Meta: Update ReadMe with a new screenshot :^) 2019-02-27 12:17:43 +00:00			`* ext2 filesystem`
Meta: Tweak ReadMe. 2019-06-07 15:57:03 +00:00			`* POSIX signals`
Meta: Update ReadMe and move build instructions to a separate document 2019-12-29 15:23:50 +00:00			`* Purgeable memory`
Meta: Update ReadMe with a new screenshot :^) 2019-02-27 12:17:43 +00:00			`* /proc filesystem`
Meta: Tweak ReadMe and add a new screenshot. 2019-04-30 13:27:35 +00:00			`* Pseudoterminals (with /dev/pts filesystem)`
Meta: Add some recently-added features to the list 2019-08-05 14:26:39 +00:00			`* Filesystem notifications`
Meta: Edit the ReadMe a little bit :^) 2020-02-06 14:50:52 +00:00			`* CPU and memory profiling`
Meta: Add some recently-added features to the list 2019-08-05 14:26:39 +00:00			`* SoundBlaster 16 driver`
Meta: Edit the ReadMe a little bit :^) 2020-02-06 14:50:52 +00:00			`* VMWare/QEMU mouse integration`

			`## System services`

			`* Launch/session daemon (SystemServer)`
			`* Compositing window server (WindowServer)`
Meta: Add more system services to ReadMe.md 2020-03-14 17:03:20 +00:00			`* Text console manager (TTYServer)`
Meta: Edit the ReadMe a little bit :^) 2020-02-06 14:50:52 +00:00			`* DNS client (LookupServer)`
Meta: Add more system services to ReadMe.md 2020-03-14 17:03:20 +00:00			`* Network protocols server (ProtocolServer)`
Meta: Edit the ReadMe a little bit :^) 2020-02-06 14:50:52 +00:00			`* Software-mixing sound daemon (AudioServer)`
Meta: Add more system services to ReadMe.md 2020-03-14 17:03:20 +00:00			`* Desktop notifications (NotificationServer)`
			`* HTTP server (WebServer)`
			`* Telnet server (TelnetServer)`
Meta: Update ReadMe a bit, add link to issue policy 2020-05-09 07:50:49 +00:00			`* DHCP client (DHCPClient)`
Meta: Edit the ReadMe a little bit :^) 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)`
LibWeb: Rename directory LibHTML => LibWeb Let's rename this to LibWeb since it aims to provide more parts of the web platform than just HTML. :^) 2020-03-07 09:32:51 +00:00			`* HTML/CSS engine (LibWeb)`
Meta: Add more libraries to ReadMe.md 2020-03-14 17:03:41 +00:00			`* JavaScript engine (LibJS)`
Meta: Edit the ReadMe a little bit :^) 2020-02-06 14:50:52 +00:00			`* Markdown (LibMarkdown)`
			`* Audio (LibAudio)`
			`* PCI database (LibPCIDB)`
			`* Terminal emulation (LibVT)`
Meta: Update ReadMe a bit, add link to issue policy 2020-05-09 07:50:49 +00:00			`* Out-of-process network protocol I/O (LibProtocol)`
Meta: Add more libraries to ReadMe.md 2020-03-14 17:03:41 +00:00			`* Mathematical functions (LibM)`
			`* ELF file handing (LibELF)`
			`* POSIX threading (LibPthread)`
			`* Higher-level threading (LibThread)`
Meta: Update ReadMe a bit, add link to issue policy 2020-05-09 07:50:49 +00:00			`* Transport Layer Security (LibTLS)`
			`* HTTP and HTTPS (LibHTTP)`
Meta: Edit the ReadMe a little bit :^) 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)`
Meta: Tweak ReadMe and add a new screenshot. 2019-03-20 14:52:37 +00:00			`* IRC client`
Meta: Edit the ReadMe a little bit :^) 2020-02-06 14:50:52 +00:00			`* Desktop synthesizer (Piano)`
			`* Various desktop apps & games`
			`* Color themes`
Add a little ReadMe. 2019-02-08 10:04:23 +00:00
Meta: Add github link to the man pages from ReadMe.md Closes #2039 2020-05-26 11:12:25 +00:00			`## How do I read the documentation?`

			`Man pages are browsable outside of SerenityOS under [Base/usr/share/man](https://github.com/SerenityOS/serenity/tree/master/Base/usr/share/man).`

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

Meta: Tweak ReadMe and add a new screenshot. 2019-03-20 14:52:37 +00:00			`## How do I build and run this?`
Meta: Add some quick instructions for how to build and run this thing. 2019-02-17 08:45:39 +00:00
Meta: Fix typo in ReadMe 2019-12-29 15:25:06 +00:00			`See the [SerenityOS build instructions](https://github.com/SerenityOS/serenity/blob/master/Documentation/BuildInstructions.md)`
Meta: Update ReadMe and move build instructions to a separate document 2019-12-29 15:23:50 +00:00
Meta: Update ReadMe a bit, add link to issue policy 2020-05-09 07:50:49 +00:00			`## Before opening an issue`

			`Please see the [issue policy](https://github.com/SerenityOS/serenity/blob/master/CONTRIBUTING.md#issue-policy).`

Meta: Link to the serenityos-dev mailing list in ReadMe 2020-08-12 15:35:07 +00:00			`## Communication hubs`
Meta: Update ReadMe and move build instructions to a separate document 2019-12-29 15:23:50 +00:00
Meta: Link to the serenityos-dev mailing list in ReadMe 2020-08-12 15:35:07 +00:00			The main hub is `#serenityos` on the Freenode IRC network.

			`We also have a project mailing list: [serenityos-dev](https://lists.sr.ht/~awesomekling/serenityos-dev).`
Meta: Add IRC channel to the ReadMe. Bonus points to anyone who joins using the Serenity IRCClient. ;^) 2019-05-03 14:25:15 +00:00
Add a little ReadMe. 2019-02-08 10:04:23 +00:00			`## Author`

Meta: Tweak ReadMe. 2019-06-07 15:57:03 +00:00			`* Andreas Kling - [awesomekling](https://twitter.com/awesomekling)`

			`## Contributors`

ReadMe: Add myself to authors section while I'm doing something useful 2019-05-25 23:25:42 +00:00			`* Robin Burchell - [rburchell](https://github.com/rburchell)`
Meta: Time for a new screnshot! :^) 2019-09-18 10:15:02 +00:00			`* Conrad Pankoff - [deoxxa](https://github.com/deoxxa)`
			`* Sergey Bugaev - [bugaevc](https://github.com/bugaevc)`
Meta: Add supercomputer7 to contributor list in ReadMe 2020-04-10 11:55:33 +00:00			`* Liav A - [supercomputer7](https://github.com/supercomputer7)`
Meta: Add Linus, Ali and Shannon to the "Contributors" list I've been adding people here after they cross over the 100 commit line. Make that criteria explicit in the text. 2020-05-17 11:13:40 +00:00			`* Linus Groh - [linusg](https://github.com/linusg)`
			`* Ali Mohammad Pur - [alimpfard](https://github.com/alimpfard)`
			`* Shannon Booth - [shannonbooth](https://github.com/shannonbooth)`
Meta: Add Hüseyin to contributors list :^) He recently passed 100 commits in the projects! 2020-06-23 17:34:11 +00:00			`* Hüseyin ASLITÜRK - [asliturk](https://github.com/asliturk)`
Meta: Add Matthew Olsson to the contributors list :^) 2020-07-25 13:22:23 +00:00			`* Matthew Olsson - [mattco98](https://github.com/mattco98)`
Meta: Add Nico Weber to the contributors list :^) 2020-08-03 16:37:08 +00:00			`* Nico Weber - [nico](https://github.com/nico)`
Meta: Add Brian Gianforcaro to the contributors list :^) 2020-08-05 20:06:31 +00:00			`* Brian Gianforcaro - [bgianfo](https://github.com/bgianfo)`
Meta: Add Ben Wiederhake to the contributors list :^) 2020-08-12 18:51:47 +00:00			`* Ben Wiederhake - [BenWiederhake](https://github.com/BenWiederhake)`
Meta: Add Tom (tomuta) to the contributors list :^) 2020-08-21 13:04:27 +00:00			`* Tom - [tomuta](https://github.com/tomuta)`
Add a little ReadMe. 2019-02-08 10:04:23 +00:00
Meta: Add Linus, Ali and Shannon to the "Contributors" list I've been adding people here after they cross over the 100 commit line. Make that criteria explicit in the text. 2020-05-17 11:13:40 +00:00			`(And many more!) The people listed above have landed more than 100 commits in the project. :^)`
Meta: Tweak ReadMe. 2019-06-07 15:57:03 +00:00
Add a little ReadMe. 2019-02-08 10:04:23 +00:00			`## License`

Meta: Update ReadMe and move build instructions to a separate document 2019-12-29 15:23:50 +00:00			`SerenityOS is licensed under a 2-clause BSD license.`