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

## Current features (all under development, some more mature than others)

* 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()
* Purgeable memory
* /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)
* HTML/CSS engine
* Web browser
* C++ IDE
* Sampling profiler with GUI
* 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
* Color theming
* Ports system (needs more packages!)
* Other stuff I can't think of right now...

## How do I build and run this?

See the [https://github.com/SerenityOS/serenity/blob/master/Documentation/BuildInstructions.md](SerenityOS build instructions).

## Wanna talk?

Come chat with us in `#serenityos` on the Freenode IRC network.

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

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

## 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: Tweak ReadMe and add a new screenshot. 2019-04-30 13:27:35 +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 me, for me, based on the things I like.`
Add a little ReadMe. 2019-02-08 10:04:23 +00:00
Meta: Tweak ReadMe and add a new screenshot. 2019-04-30 13:27:35 +00:00			`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." :^)`

Meta: Tweak ReadMe. 2019-06-07 15:57:03 +00:00			`I regularly post raw hacking sessions and demos on [my YouTube channel](https://www.youtube.com/c/AndreasKling/).`

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 (Quake edition) :^) 2019-11-06 20:50:47 +00:00			`![Screenshot as of 1133aca](https://raw.githubusercontent.com/SerenityOS/serenity/master/Meta/screenshot-1133aca.png)`
Meta: Update ReadMe with a new screenshot. :^) 2019-02-12 14:47:37 +00:00
Meta: Update ReadMe and move build instructions to a separate document 2019-12-29 15:23:50 +00:00			`## Current features (all under development, some more mature than others)`
Add a little ReadMe. 2019-02-08 10:04:23 +00:00
			`* Pre-emptive multitasking`
Meta: Time for a new screenshot :^) Also update ReadMe with a link to the build instructions. 2019-04-05 23:31:12 +00:00			`* Multithreading`
Meta: Time for a new screenshot! :^) 2019-03-08 00:10:33 +00:00			`* Compositing window server`
Meta: Tweak ReadMe and add a new screenshot. 2019-03-20 14:52:37 +00:00			`* IPv4 networking with ARP, TCP, UDP and ICMP`
Meta: Update ReadMe with a new screenshot :^) 2019-02-27 12:17:43 +00:00			`* ext2 filesystem`
Add a little ReadMe. 2019-02-08 10:04:23 +00:00			`* Unix-like libc and userland`
Meta: Tweak ReadMe. 2019-06-07 15:57:03 +00:00			`* POSIX signals`
Meta: Tweak ReadMe and add a new screenshot. 2019-04-30 13:27:35 +00:00			`* Shell with pipes and I/O redirection`
Meta: Update ReadMe with a new screenshot :^) 2019-02-27 12:17:43 +00:00			`* mmap()`
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`
			`* Local sockets`
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: Tweak ReadMe. 2019-06-30 08:11:13 +00:00			`* JSON framework`
			`* Low-level utility library (LibCore)`
Meta: Add some recently-added features to the list 2019-08-05 14:26:39 +00:00			`* Mid-level 2D graphics library (LibDraw)`
Meta: Update ReadMe with license and links. 2019-04-15 12:16:45 +00:00			`* High-level GUI library (LibGUI)`
Meta: Time for a new screenshot (Quake edition) :^) 2019-11-06 20:50:47 +00:00			`* HTML/CSS engine`
			`* Web browser`
			`* C++ IDE`
Meta: Update ReadMe and move build instructions to a separate document 2019-12-29 15:23:50 +00:00			`* Sampling profiler with GUI`
Meta: Time for a new screnshot! :^) 2019-09-18 10:15:02 +00:00			`* Emojis (UTF-8)`
Meta: Add some recently-added features to the list 2019-08-05 14:26:39 +00:00			`* HTTP downloads`
			`* SoundBlaster 16 driver`
			`* Software-mixing sound daemon`
			`* WAV playback`
			`* Simple desktop piano/synthesizer`
Meta: Tweak ReadMe and add a new screenshot. 2019-04-30 13:27:35 +00:00			`* Visual GUI design tool`
Meta: Time for a new screenshot :^) Also update ReadMe with a link to the build instructions. 2019-04-05 23:31:12 +00:00			`* PNG format support`
Meta: Tweak ReadMe and add a new screenshot. 2019-03-20 14:52:37 +00:00			`* Text editor`
			`* IRC client`
Meta: Tweak ReadMe. 2019-06-30 08:11:13 +00:00			`* Simple painting application`
Meta: Tweak ReadMe and add a new screenshot. 2019-03-20 14:52:37 +00:00			`* DNS lookup`
Meta: Tweak ReadMe and add a new screenshot. 2019-04-30 13:27:35 +00:00			`* Desktop games: Minesweeper and Snake`
Meta: Update ReadMe and move build instructions to a separate document 2019-12-29 15:23:50 +00:00			`* Color theming`
Meta: Tweak ReadMe. 2019-06-07 15:57:03 +00:00			`* Ports system (needs more packages!)`
Add a little ReadMe. 2019-02-08 10:04:23 +00:00			`* Other stuff I can't think of right now...`

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: Update ReadMe and move build instructions to a separate document 2019-12-29 15:23:50 +00:00			`See the [https://github.com/SerenityOS/serenity/blob/master/Documentation/BuildInstructions.md](SerenityOS build instructions).`

			`## Wanna talk?`

			Come chat with us in `#serenityos` on the Freenode IRC network.
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)`
Add a little ReadMe. 2019-02-08 10:04:23 +00:00
Meta: Time for a new screnshot! :^) 2019-09-18 10:15:02 +00:00			`(And many more!) Feel free to append yourself here if you've made some sweet contributions. :)`
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.`