ladybird/README.md

141 lines
10 KiB
Markdown
Raw Normal View History

# SerenityOS
2019-02-08 13:04:23 +03:00
2022-10-04 02:48:37 +03:00
Graphical Unix-like operating system for x86-64 computers.
2019-02-08 13:04:23 +03:00
2021-08-17 19:51:41 +03:00
[![GitHub Actions 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")
[![Azure DevOps Status](https://dev.azure.com/SerenityOS/SerenityOS/_apis/build/status/CI?branchName=master)](https://dev.azure.com/SerenityOS/SerenityOS/_build/latest?definitionId=1&branchName=master)
[![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)
[![Sonar Cube Static Analysis](https://sonarcloud.io/api/project_badges/measure?project=SerenityOS_serenity&metric=ncloc)](https://sonarcloud.io/dashboard?id=SerenityOS_serenity)
[![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
[FAQ](Documentation/FAQ.md) | [Documentation](#how-do-i-read-the-documentation) | [Build Instructions](#how-do-i-build-and-run-this)
2019-02-08 13:04:23 +03: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 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
You can watch videos of the system being developed on YouTube:
2019-06-07 18:57:03 +03:00
* [Andreas Kling's channel](https://youtube.com/andreaskling)
* [Linus Groh's channel](https://youtube.com/linusgroh)
* [kleines Filmröllchen's channel](https://www.youtube.com/c/kleinesfilmroellchen)
## Screenshot
![Screenshot as of c03b788.png](Meta/Screenshots/screenshot-c03b788.png)
Meta: Completely overhaul the README The README was getting a bit outdated in places, and it didn't have its priorities straight (libc uwu, also we have browser no big deal). These changes are largely based on what was discussed among major contributors and maintainers, though I put in some extra stuff I'm bothered by. The start of README is unchanged. The project blurb is probably its best part, both then and now, so it definitely stays. The FAQ is moved up under the About section because it's easier to find that way and makes more sense logically. The Features section is a highly compressed version of the previous several features sections. Priorities are a big focus here: List what matters to a reader, what they will likely care about, what's impressive to them and what's probably not. The list therefore starts with the factual basics about the Kernel followed directly by Browser+LibJS, the probably biggest userland feat in this project. Then, we pedal back and talk about OS basics, like security, POSIX, services, libraries, devtools. We finish out by addressing the end user concerns (customization, UI apps, multimedia & file format support), which includes a bunch of things previously underrepresented. I think it's rather important that Serenity has a unified style and UX philosophy, so this should definitely be mentioned :^) At the end, I think it's very important to state the NIH philosophy, but also the fact that there are more than two hundred (!) ports. Documentation section is slightly expanded to mention the Documentation folder which doesn't really appear anywhere in the previous version. Build instructions include a simple mention of the fact that Serenity runs on almost anything. It's good to not scare off Windows users :^)) (self-deprecating humour overload) The Get in Touch section and the issues section are combined into one "how do i talk to u help" section that contains the same information but includes a general link to CONTRIBUTING. The Contributors section is now one big list of 100+ commit people. Also, the GitHub contributor list is linked, as that lists over 30 additional people IIRC + detailed statistics.
2022-03-28 22:33:13 +03:00
## Features
2022-10-04 02:48:37 +03:00
* Modern x86 64-bit kernel with pre-emptive multi-threading
* [Browser](Userland/Applications/Browser/) with JavaScript, WebAssembly, and more (check the spec compliance for [JS](https://serenityos.github.io/libjs-website/test262/), [CSS](https://css.tobyase.de/), and [Wasm](https://serenityos.github.io/libjs-website/wasm/))
Meta: Completely overhaul the README The README was getting a bit outdated in places, and it didn't have its priorities straight (libc uwu, also we have browser no big deal). These changes are largely based on what was discussed among major contributors and maintainers, though I put in some extra stuff I'm bothered by. The start of README is unchanged. The project blurb is probably its best part, both then and now, so it definitely stays. The FAQ is moved up under the About section because it's easier to find that way and makes more sense logically. The Features section is a highly compressed version of the previous several features sections. Priorities are a big focus here: List what matters to a reader, what they will likely care about, what's impressive to them and what's probably not. The list therefore starts with the factual basics about the Kernel followed directly by Browser+LibJS, the probably biggest userland feat in this project. Then, we pedal back and talk about OS basics, like security, POSIX, services, libraries, devtools. We finish out by addressing the end user concerns (customization, UI apps, multimedia & file format support), which includes a bunch of things previously underrepresented. I think it's rather important that Serenity has a unified style and UX philosophy, so this should definitely be mentioned :^) At the end, I think it's very important to state the NIH philosophy, but also the fact that there are more than two hundred (!) ports. Documentation section is slightly expanded to mention the Documentation folder which doesn't really appear anywhere in the previous version. Build instructions include a simple mention of the fact that Serenity runs on almost anything. It's good to not scare off Windows users :^)) (self-deprecating humour overload) The Get in Touch section and the issues section are combined into one "how do i talk to u help" section that contains the same information but includes a general link to CONTRIBUTING. The Contributors section is now one big list of 100+ commit people. Also, the GitHub contributor list is linked, as that lists over 30 additional people IIRC + detailed statistics.
2022-03-28 22:33:13 +03:00
* Security features (hardware protections, limited userland capabilities, W^X memory, `pledge` & `unveil`, (K)ASLR, OOM-resistance, web-content isolation, state-of-the-art TLS algorithms, ...)
* [System services](Userland/Services/) (WindowServer, LoginServer, AudioServer, WebServer, RequestServer, CrashServer, ...) and modern IPC
* Good POSIX compatibility ([LibC](Userland/Libraries/LibC/), Shell, syscalls, signals, pseudoterminals, filesystem notifications, standard Unix [utilities](Userland/Utilities/), ...)
* POSIX-like virtual file systems (/proc, /dev, /sys, /tmp, ...) and ext2 file system
* Network stack and applications with support for IPv4, TCP, UDP; DNS, HTTP, Gemini, IMAP, NTP
* Profiling, debugging and other development tools (Kernel-supported profiling, CrashReporter, interactive GUI playground, HexEditor, HackStudio IDE for C++ and more)
Meta: Completely overhaul the README The README was getting a bit outdated in places, and it didn't have its priorities straight (libc uwu, also we have browser no big deal). These changes are largely based on what was discussed among major contributors and maintainers, though I put in some extra stuff I'm bothered by. The start of README is unchanged. The project blurb is probably its best part, both then and now, so it definitely stays. The FAQ is moved up under the About section because it's easier to find that way and makes more sense logically. The Features section is a highly compressed version of the previous several features sections. Priorities are a big focus here: List what matters to a reader, what they will likely care about, what's impressive to them and what's probably not. The list therefore starts with the factual basics about the Kernel followed directly by Browser+LibJS, the probably biggest userland feat in this project. Then, we pedal back and talk about OS basics, like security, POSIX, services, libraries, devtools. We finish out by addressing the end user concerns (customization, UI apps, multimedia & file format support), which includes a bunch of things previously underrepresented. I think it's rather important that Serenity has a unified style and UX philosophy, so this should definitely be mentioned :^) At the end, I think it's very important to state the NIH philosophy, but also the fact that there are more than two hundred (!) ports. Documentation section is slightly expanded to mention the Documentation folder which doesn't really appear anywhere in the previous version. Build instructions include a simple mention of the fact that Serenity runs on almost anything. It's good to not scare off Windows users :^)) (self-deprecating humour overload) The Get in Touch section and the issues section are combined into one "how do i talk to u help" section that contains the same information but includes a general link to CONTRIBUTING. The Contributors section is now one big list of 100+ commit people. Also, the GitHub contributor list is linked, as that lists over 30 additional people IIRC + detailed statistics.
2022-03-28 22:33:13 +03:00
* [Libraries](Userland/Libraries/) for everything from cryptography to OpenGL, audio, JavaScript, GUI, playing chess, ...
* Support for many common and uncommon file formats (PNG, JPEG, GIF, MP3, WAV, FLAC, ZIP, TAR, PDF, QOI, Gemini, ...)
* Unified style and design philosophy, flexible theming system, [custom (bitmap and vector) fonts](https://fonts.serenityos.net/font-family)
* [Games](Userland/Games/) (Solitaire, Minesweeper, 2048, chess, Conway's Game of Life, ...) and [demos](Userland/Demos/) (CatDog, Starfield, Eyes, mandelbrot set, WidgetGallery, ...)
* Every-day GUI programs and utilities (Spreadsheet with JavaScript, TextEditor, Terminal, PixelPaint, various multimedia viewers and players, Mail, Assistant, Calculator, ...)
... 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](Ports/AvailablePorts.md), including games, compilers, Unix tools, multimedia apps and more.
2019-02-08 13:04:23 +03:00
## How do I read the documentation?
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.
When running SerenityOS you can use `man` for the terminal interface, or `help` for the GUI.
Meta: Completely overhaul the README The README was getting a bit outdated in places, and it didn't have its priorities straight (libc uwu, also we have browser no big deal). These changes are largely based on what was discussed among major contributors and maintainers, though I put in some extra stuff I'm bothered by. The start of README is unchanged. The project blurb is probably its best part, both then and now, so it definitely stays. The FAQ is moved up under the About section because it's easier to find that way and makes more sense logically. The Features section is a highly compressed version of the previous several features sections. Priorities are a big focus here: List what matters to a reader, what they will likely care about, what's impressive to them and what's probably not. The list therefore starts with the factual basics about the Kernel followed directly by Browser+LibJS, the probably biggest userland feat in this project. Then, we pedal back and talk about OS basics, like security, POSIX, services, libraries, devtools. We finish out by addressing the end user concerns (customization, UI apps, multimedia & file format support), which includes a bunch of things previously underrepresented. I think it's rather important that Serenity has a unified style and UX philosophy, so this should definitely be mentioned :^) At the end, I think it's very important to state the NIH philosophy, but also the fact that there are more than two hundred (!) ports. Documentation section is slightly expanded to mention the Documentation folder which doesn't really appear anywhere in the previous version. Build instructions include a simple mention of the fact that Serenity runs on almost anything. It's good to not scare off Windows users :^)) (self-deprecating humour overload) The Get in Touch section and the issues section are combined into one "how do i talk to u help" section that contains the same information but includes a general link to CONTRIBUTING. The Contributors section is now one big list of 100+ commit people. Also, the GitHub contributor list is linked, as that lists over 30 additional people IIRC + detailed statistics.
2022-03-28 22:33:13 +03:00
Code-related documentation can be found in the [documentation](Documentation/) folder.
Meta: Completely overhaul the README The README was getting a bit outdated in places, and it didn't have its priorities straight (libc uwu, also we have browser no big deal). These changes are largely based on what was discussed among major contributors and maintainers, though I put in some extra stuff I'm bothered by. The start of README is unchanged. The project blurb is probably its best part, both then and now, so it definitely stays. The FAQ is moved up under the About section because it's easier to find that way and makes more sense logically. The Features section is a highly compressed version of the previous several features sections. Priorities are a big focus here: List what matters to a reader, what they will likely care about, what's impressive to them and what's probably not. The list therefore starts with the factual basics about the Kernel followed directly by Browser+LibJS, the probably biggest userland feat in this project. Then, we pedal back and talk about OS basics, like security, POSIX, services, libraries, devtools. We finish out by addressing the end user concerns (customization, UI apps, multimedia & file format support), which includes a bunch of things previously underrepresented. I think it's rather important that Serenity has a unified style and UX philosophy, so this should definitely be mentioned :^) At the end, I think it's very important to state the NIH philosophy, but also the fact that there are more than two hundred (!) ports. Documentation section is slightly expanded to mention the Documentation folder which doesn't really appear anywhere in the previous version. Build instructions include a simple mention of the fact that Serenity runs on almost anything. It's good to not scare off Windows users :^)) (self-deprecating humour overload) The Get in Touch section and the issues section are combined into one "how do i talk to u help" section that contains the same information but includes a general link to CONTRIBUTING. The Contributors section is now one big list of 100+ commit people. Also, the GitHub contributor list is linked, as that lists over 30 additional people IIRC + detailed statistics.
2022-03-28 22:33:13 +03:00
## How do I build and run this?
Meta: Completely overhaul the README The README was getting a bit outdated in places, and it didn't have its priorities straight (libc uwu, also we have browser no big deal). These changes are largely based on what was discussed among major contributors and maintainers, though I put in some extra stuff I'm bothered by. The start of README is unchanged. The project blurb is probably its best part, both then and now, so it definitely stays. The FAQ is moved up under the About section because it's easier to find that way and makes more sense logically. The Features section is a highly compressed version of the previous several features sections. Priorities are a big focus here: List what matters to a reader, what they will likely care about, what's impressive to them and what's probably not. The list therefore starts with the factual basics about the Kernel followed directly by Browser+LibJS, the probably biggest userland feat in this project. Then, we pedal back and talk about OS basics, like security, POSIX, services, libraries, devtools. We finish out by addressing the end user concerns (customization, UI apps, multimedia & file format support), which includes a bunch of things previously underrepresented. I think it's rather important that Serenity has a unified style and UX philosophy, so this should definitely be mentioned :^) At the end, I think it's very important to state the NIH philosophy, but also the fact that there are more than two hundred (!) ports. Documentation section is slightly expanded to mention the Documentation folder which doesn't really appear anywhere in the previous version. Build instructions include a simple mention of the fact that Serenity runs on almost anything. It's good to not scare off Windows users :^)) (self-deprecating humour overload) The Get in Touch section and the issues section are combined into one "how do i talk to u help" section that contains the same information but includes a general link to CONTRIBUTING. The Contributors section is now one big list of 100+ commit people. Also, the GitHub contributor list is linked, as that lists over 30 additional people IIRC + detailed statistics.
2022-03-28 22:33:13 +03:00
See the [SerenityOS build instructions](https://github.com/SerenityOS/serenity/blob/master/Documentation/BuildInstructions.md). Serenity runs on Linux, macOS (aarch64 might be a challenge), Windows (with WSL2) and many other *Nixes with hardware or software virtualization.
Meta: Completely overhaul the README The README was getting a bit outdated in places, and it didn't have its priorities straight (libc uwu, also we have browser no big deal). These changes are largely based on what was discussed among major contributors and maintainers, though I put in some extra stuff I'm bothered by. The start of README is unchanged. The project blurb is probably its best part, both then and now, so it definitely stays. The FAQ is moved up under the About section because it's easier to find that way and makes more sense logically. The Features section is a highly compressed version of the previous several features sections. Priorities are a big focus here: List what matters to a reader, what they will likely care about, what's impressive to them and what's probably not. The list therefore starts with the factual basics about the Kernel followed directly by Browser+LibJS, the probably biggest userland feat in this project. Then, we pedal back and talk about OS basics, like security, POSIX, services, libraries, devtools. We finish out by addressing the end user concerns (customization, UI apps, multimedia & file format support), which includes a bunch of things previously underrepresented. I think it's rather important that Serenity has a unified style and UX philosophy, so this should definitely be mentioned :^) At the end, I think it's very important to state the NIH philosophy, but also the fact that there are more than two hundred (!) ports. Documentation section is slightly expanded to mention the Documentation folder which doesn't really appear anywhere in the previous version. Build instructions include a simple mention of the fact that Serenity runs on almost anything. It's good to not scare off Windows users :^)) (self-deprecating humour overload) The Get in Touch section and the issues section are combined into one "how do i talk to u help" section that contains the same information but includes a general link to CONTRIBUTING. The Contributors section is now one big list of 100+ commit people. Also, the GitHub contributor list is linked, as that lists over 30 additional people IIRC + detailed statistics.
2022-03-28 22:33:13 +03:00
## Get in touch and participate!
Join our Discord server: [SerenityOS Discord](https://discord.gg/serenityos)
Meta: Completely overhaul the README The README was getting a bit outdated in places, and it didn't have its priorities straight (libc uwu, also we have browser no big deal). These changes are largely based on what was discussed among major contributors and maintainers, though I put in some extra stuff I'm bothered by. The start of README is unchanged. The project blurb is probably its best part, both then and now, so it definitely stays. The FAQ is moved up under the About section because it's easier to find that way and makes more sense logically. The Features section is a highly compressed version of the previous several features sections. Priorities are a big focus here: List what matters to a reader, what they will likely care about, what's impressive to them and what's probably not. The list therefore starts with the factual basics about the Kernel followed directly by Browser+LibJS, the probably biggest userland feat in this project. Then, we pedal back and talk about OS basics, like security, POSIX, services, libraries, devtools. We finish out by addressing the end user concerns (customization, UI apps, multimedia & file format support), which includes a bunch of things previously underrepresented. I think it's rather important that Serenity has a unified style and UX philosophy, so this should definitely be mentioned :^) At the end, I think it's very important to state the NIH philosophy, but also the fact that there are more than two hundred (!) ports. Documentation section is slightly expanded to mention the Documentation folder which doesn't really appear anywhere in the previous version. Build instructions include a simple mention of the fact that Serenity runs on almost anything. It's good to not scare off Windows users :^)) (self-deprecating humour overload) The Get in Touch section and the issues section are combined into one "how do i talk to u help" section that contains the same information but includes a general link to CONTRIBUTING. The Contributors section is now one big list of 100+ commit people. Also, the GitHub contributor list is linked, as that lists over 30 additional people IIRC + detailed statistics.
2022-03-28 22:33:13 +03:00
Before opening an issue, please see the [issue policy](https://github.com/SerenityOS/serenity/blob/master/CONTRIBUTING.md#issue-policy).
2019-02-08 13:04:23 +03:00
Meta: Completely overhaul the README The README was getting a bit outdated in places, and it didn't have its priorities straight (libc uwu, also we have browser no big deal). These changes are largely based on what was discussed among major contributors and maintainers, though I put in some extra stuff I'm bothered by. The start of README is unchanged. The project blurb is probably its best part, both then and now, so it definitely stays. The FAQ is moved up under the About section because it's easier to find that way and makes more sense logically. The Features section is a highly compressed version of the previous several features sections. Priorities are a big focus here: List what matters to a reader, what they will likely care about, what's impressive to them and what's probably not. The list therefore starts with the factual basics about the Kernel followed directly by Browser+LibJS, the probably biggest userland feat in this project. Then, we pedal back and talk about OS basics, like security, POSIX, services, libraries, devtools. We finish out by addressing the end user concerns (customization, UI apps, multimedia & file format support), which includes a bunch of things previously underrepresented. I think it's rather important that Serenity has a unified style and UX philosophy, so this should definitely be mentioned :^) At the end, I think it's very important to state the NIH philosophy, but also the fact that there are more than two hundred (!) ports. Documentation section is slightly expanded to mention the Documentation folder which doesn't really appear anywhere in the previous version. Build instructions include a simple mention of the fact that Serenity runs on almost anything. It's good to not scare off Windows users :^)) (self-deprecating humour overload) The Get in Touch section and the issues section are combined into one "how do i talk to u help" section that contains the same information but includes a general link to CONTRIBUTING. The Contributors section is now one big list of 100+ commit people. Also, the GitHub contributor list is linked, as that lists over 30 additional people IIRC + detailed statistics.
2022-03-28 22:33:13 +03:00
A general guide for contributing can be found in [`CONTRIBUTING.md`](CONTRIBUTING.md).
2019-06-07 18:57:03 +03:00
Meta: Completely overhaul the README The README was getting a bit outdated in places, and it didn't have its priorities straight (libc uwu, also we have browser no big deal). These changes are largely based on what was discussed among major contributors and maintainers, though I put in some extra stuff I'm bothered by. The start of README is unchanged. The project blurb is probably its best part, both then and now, so it definitely stays. The FAQ is moved up under the About section because it's easier to find that way and makes more sense logically. The Features section is a highly compressed version of the previous several features sections. Priorities are a big focus here: List what matters to a reader, what they will likely care about, what's impressive to them and what's probably not. The list therefore starts with the factual basics about the Kernel followed directly by Browser+LibJS, the probably biggest userland feat in this project. Then, we pedal back and talk about OS basics, like security, POSIX, services, libraries, devtools. We finish out by addressing the end user concerns (customization, UI apps, multimedia & file format support), which includes a bunch of things previously underrepresented. I think it's rather important that Serenity has a unified style and UX philosophy, so this should definitely be mentioned :^) At the end, I think it's very important to state the NIH philosophy, but also the fact that there are more than two hundred (!) ports. Documentation section is slightly expanded to mention the Documentation folder which doesn't really appear anywhere in the previous version. Build instructions include a simple mention of the fact that Serenity runs on almost anything. It's good to not scare off Windows users :^)) (self-deprecating humour overload) The Get in Touch section and the issues section are combined into one "how do i talk to u help" section that contains the same information but includes a general link to CONTRIBUTING. The Contributors section is now one big list of 100+ commit people. Also, the GitHub contributor list is linked, as that lists over 30 additional people IIRC + detailed statistics.
2022-03-28 22:33:13 +03:00
## Authors
2019-06-07 18:57:03 +03:00
* **Andreas Kling** - [awesomekling](https://twitter.com/awesomekling) [![GitHub Sponsors](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/awesomekling)
* **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)
* **Liav A** - [supercomputer7](https://github.com/supercomputer7)
* **Linus Groh** - [linusg](https://github.com/linusg) [![GitHub Sponsors](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/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)
* **Paul Scharnofske** - [asynts](https://github.com/asynts)
* **Itamar Shenhar** - [itamar8910](https://github.com/itamar8910)
* **Luke Wilde** - [Lubrsi](https://github.com/Lubrsi)
* **Brendan Coles** - [bcoles](https://github.com/bcoles)
* **Andrew Kaster** - [ADKaster](https://github.com/ADKaster) [![GitHub Sponsors](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ADKaster)
* **thankyouverycool** - [thankyouverycool](https://github.com/thankyouverycool)
* **Idan Horowitz** - [IdanHo](https://github.com/IdanHo)
* **Gunnar Beutner** - [gunnarbeutner](https://github.com/gunnarbeutner)
* **Tim Flynn** - [trflynn89](https://github.com/trflynn89)
* **Jean-Baptiste Boric** - [boricj](https://github.com/boricj)
* **Stephan Unverwerth** - [sunverwerth](https://github.com/sunverwerth)
* **Max Wipfli** - [MaxWipfli](https://github.com/MaxWipfli)
* **Daniel Bertalan** - [BertalanD](https://github.com/BertalanD)
* **Jelle Raaijmakers** - [GMTA](https://github.com/GMTA)
* **Sam Atkins** - [AtkinsSJ](https://github.com/AtkinsSJ) [![GitHub Sponsors](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/AtkinsSJ)
* **Tobias Christiansen** - [TobyAsE](https://github.com/TobyAsE)
* **Lenny Maiorani** - [ldm5180](https://github.com/ldm5180)
* **sin-ack** - [sin-ack](https://github.com/sin-ack)
* **Jesse Buhagiar** - [Quaker762](https://github.com/Quaker762)
* **Peter Elliott** - [Petelliott](https://github.com/Petelliott)
* **Karol Kosek** - [krkk](https://github.com/krkk)
* **Mustafa Quraish** - [mustafaquraish](https://github.com/mustafaquraish)
* **David Tuin** - [davidot](https://github.com/davidot)
* **Leon Albrecht** - [Hendiadyoin1](https://github.com/Hendiadyoin1)
* **Tim Schumacher** - [timschumi](https://github.com/timschumi)
* **Marcus Nilsson** - [metmo](https://github.com/metmo)
* **Gegga Thor** - [Xexxa](https://github.com/Xexxa) [![GitHub Sponsors](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/Xexxa)
* **kleines Filmröllchen** - [kleinesfilmroellchen](https://github.com/kleinesfilmroellchen) [![GitHub Sponsors](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/kleinesfilmroellchen)
* **Kenneth Myhra** - [kennethmyhra](https://github.com/kennethmyhra)
* **Maciej** - [sppmacd](https://github.com/sppmacd)
* **Sahan Fernando** - [ccapitalK](https://github.com/ccapitalK)
* **Benjamin Maxwell** - [MacDue](https://github.com/MacDue)
* **Dennis Esternon** - [djwisdom](https://github.com/djwisdom) [![GitHub Sponsors](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/djwisdom)
* **frhun** - [frhun](https://github.com/frhun)
* **networkException** - [networkException](https://github.com/networkException) [![GitHub Sponsors](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/networkException)
* **Brandon Jordan** - [electrikmilk](https://github.com/electrikmilk)
* **Lucas Chollet** - [LucasChollet](https://github.com/LucasChollet)
* **Timon Kruiper** - [FireFox317](https://github.com/FireFox317)
* **Martin Falisse** - [martinfalisse](https://github.com/martinfalisse)
* **Gregory Bertilson** - [Zaggy1024](https://github.com/Zaggy1024)
* **Erik Wouters** - [EWouters](https://github.com/EWouters)
* **Rodrigo Tobar** - [rtobar](https://github.com/rtobar)
* **Alexander Kalenik** - [kalenikaliaksandr](https://github.com/kalenikaliaksandr)
* **Tim Ledbetter** - [tcl3](https://github.com/tcl3)
* **Steffen T. Larssen** - [stelar7](https://github.com/stelar7)
* **Andi Gallo** - [axgallo](https://github.com/axgallo)
* **Simon Wanner** - [skyrising](https://github.com/skyrising)
* **FalseHonesty** - [FalseHonesty](https://github.com/FalseHonesty)
* **Bastiaan van der Plaat** - [bplaat](https://github.com/bplaat)
* **Dan Klishch** - [DanShaders](https://github.com/DanShaders)
2019-02-08 13:04:23 +03:00
Meta: Completely overhaul the README The README was getting a bit outdated in places, and it didn't have its priorities straight (libc uwu, also we have browser no big deal). These changes are largely based on what was discussed among major contributors and maintainers, though I put in some extra stuff I'm bothered by. The start of README is unchanged. The project blurb is probably its best part, both then and now, so it definitely stays. The FAQ is moved up under the About section because it's easier to find that way and makes more sense logically. The Features section is a highly compressed version of the previous several features sections. Priorities are a big focus here: List what matters to a reader, what they will likely care about, what's impressive to them and what's probably not. The list therefore starts with the factual basics about the Kernel followed directly by Browser+LibJS, the probably biggest userland feat in this project. Then, we pedal back and talk about OS basics, like security, POSIX, services, libraries, devtools. We finish out by addressing the end user concerns (customization, UI apps, multimedia & file format support), which includes a bunch of things previously underrepresented. I think it's rather important that Serenity has a unified style and UX philosophy, so this should definitely be mentioned :^) At the end, I think it's very important to state the NIH philosophy, but also the fact that there are more than two hundred (!) ports. Documentation section is slightly expanded to mention the Documentation folder which doesn't really appear anywhere in the previous version. Build instructions include a simple mention of the fact that Serenity runs on almost anything. It's good to not scare off Windows users :^)) (self-deprecating humour overload) The Get in Touch section and the issues section are combined into one "how do i talk to u help" section that contains the same information but includes a general link to CONTRIBUTING. The Contributors section is now one big list of 100+ commit people. Also, the GitHub contributor list is linked, as that lists over 30 additional people IIRC + detailed statistics.
2022-03-28 22:33:13 +03:00
And many more! [See here](https://github.com/SerenityOS/serenity/graphs/contributors) for a full contributor list. 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
SerenityOS is licensed under a 2-clause BSD license.