RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-27 11:57:35 +00:00
Code Issues Activity Actions

Meta: Completely overhaul the README

Browse source 
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.
This commit is contained in:
kleines Filmröllchen 2022-03-28 21:33:13 +02:00 • committed by Brian Gianforcaro
parent 747f347b75
commit 659a7a5da7
1 changed files with 28 additions and 72 deletions
Download patch file Download diff file Expand all files Collapse all files

100
README.md
View file

@ -19,72 +19,31 @@ You can watch videos of the system being developed on YouTube:
* [Andreas Kling's channel](https://youtube.com/andreaskling) * [Andreas Kling's channel](https://youtube.com/andreaskling)
* [Linus Groh's channel](https://youtube.com/linusgroh) * [Linus Groh's channel](https://youtube.com/linusgroh)
**FAQ**: [Frequently Asked Questions](https://github.com/SerenityOS/serenity/blob/master/Documentation/FAQ.md)
## Screenshot ## Screenshot
![Screenshot as of b36968c.png](https://raw.githubusercontent.com/SerenityOS/serenity/master/Meta/screenshot-b36968c.png) ![Screenshot as of b36968c.png](https://raw.githubusercontent.com/SerenityOS/serenity/master/Meta/screenshot-b36968c.png)
## Kernel features ## Features
* x86 (32-bit) and x86_64 (64-bit) kernel with pre-emptive multi-threading * Modern x86 32-bit and 64-bit kernel with pre-emptive multi-threading
* Hardware protections (SMEP, SMAP, UMIP, NX, WP, TSD, ...) * [Browser](Userland/Applications/Browser/) with JavaScript, WebAssembly, and more (check the spec compliance for [JS](https://libjs.dev/test262/), [CSS](https://css.tobyase.de/), and [WASM](https://libjs.dev/wasm/))
* IPv4 stack with ARP, TCP, UDP and ICMP protocols * 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, ...)
* ext2 filesystem * [System services](Userland/Services/) (WindowServer, LoginServer, AudioServer, WebServer, RequestServer, CrashServer, ...) and modern IPC
* POSIX signals * Good POSIX compatibility ([LibC](Userland/Libraries/LibC/), Shell, syscalls, signals, pseudoterminals, filesystem notifications, standard Unix [utilities](Userland/Utilities/), ...)
* Purgeable memory * POSIX-like virtual file systems (/proc, /dev, /sys, /tmp, ...) and ext2 file system
* /proc filesystem * Network stack and applications with support for IPv4, TCP, UDP; DNS, HTTP, Gemini, IMAP, NTP
* Pseudoterminals (with /dev/pts filesystem) * Profiling, debugging and other development tools (Kernel-supported profiling, detailed program analysis with software emulation in UserspaceEmulator, CrashReporter, interactive GUI playground, HexEditor, HackStudio IDE for C++ and more)
* Filesystem notifications * [Libraries](Userland/Libraries/) for everything from cryptography to OpenGL, audio, JavaScript, GUI, playing chess, ...
* CPU and memory profiling * Support for many common and uncommon file formats (PNG, JPEG, GIF, MP3, WAV, FLAC, ZIP, TAR, PDF, QOI, Gemini, ...)
* VMWare/QEMU mouse integration * 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, ...)
## System services ... and all of the above are right in this repository, no extra dependencies, built from-scratch by us :^)
* Launch/session daemon (SystemServer) Additionally, there are [over two hundred ports of popular open-source software](Ports/AvailablePorts.md), including games, compilers, Unix tools, multimedia apps and more.
* Compositing window server (WindowServer)
* Text console manager (TTYServer)
* DNS client (LookupServer)
* Network protocols server (RequestServer and WebSocket)
* 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)
* OpenGL 1.x compatible library (LibGL)
* GUI toolkit (LibGUI)
* Cross-process communication library (LibIPC)
* HTML/CSS engine (LibWeb)
* JavaScript engine (LibJS)
* Markdown (LibMarkdown)
* Audio (LibAudio)
* Digital Signal Processing/Synthesizer Chains (LibDSP)
* PCI database (LibPCIDB)
* Terminal emulation (LibVT)
* Out-of-process network protocol I/O (LibProtocol)
* Mathematical functions (LibM)
* ELF file handling (LibELF)
* POSIX threading (LibPthread)
* Higher-level threading (LibThreading)
* Transport Layer Security (LibTLS)
* HTTP and HTTPS (LibHTTP)
* IMAP (LibIMAP)
## 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)
* Desktop synthesizer (Piano)
* E-mail client (Mail)
* Various desktop apps & games
* Color themes
## How do I read the documentation? ## How do I read the documentation?
@ -92,26 +51,23 @@ Man pages are available online at [man.serenityos.org](https://man.serenityos.or
When running SerenityOS you can use `man` for the terminal interface, or `help` for the GUI. When running SerenityOS you can use `man` for the terminal interface, or `help` for the GUI.
Code-related documentation can be found in the [documentation](Documentation/) folder.
## How do I build and run this? ## How do I build and run this?
See the [SerenityOS build instructions](https://github.com/SerenityOS/serenity/blob/master/Documentation/BuildInstructions.md) 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.
## Before opening an issue ## Get in touch and participate!
Please see the [issue policy](https://github.com/SerenityOS/serenity/blob/master/CONTRIBUTING.md#issue-policy).
FAQ: [Frequently Asked Questions](https://github.com/SerenityOS/serenity/blob/master/Documentation/FAQ.md)
## Get in touch
Join our Discord server: [SerenityOS Discord](https://discord.gg/serenityos) Join our Discord server: [SerenityOS Discord](https://discord.gg/serenityos)
## Author Before opening an issue, please see the [issue policy](https://github.com/SerenityOS/serenity/blob/master/CONTRIBUTING.md#issue-policy).
A general guide for contributing can be found in [`CONTRIBUTING.md`](CONTRIBUTING.md).
## Authors
* **Andreas Kling** - [awesomekling](https://twitter.com/awesomekling) * **Andreas Kling** - [awesomekling](https://twitter.com/awesomekling)
## Contributors
* **Robin Burchell** - [rburchell](https://github.com/rburchell) * **Robin Burchell** - [rburchell](https://github.com/rburchell)
* **Conrad Pankoff** - [deoxxa](https://github.com/deoxxa) * **Conrad Pankoff** - [deoxxa](https://github.com/deoxxa)
* **Sergey Bugaev** - [bugaevc](https://github.com/bugaevc) * **Sergey Bugaev** - [bugaevc](https://github.com/bugaevc)
@ -156,7 +112,7 @@ Join our Discord server: [SerenityOS Discord](https://discord.gg/serenityos)
* **Kenneth Myhra** - [kennethmyhra](https://github.com/kennethmyhra) * **Kenneth Myhra** - [kennethmyhra](https://github.com/kennethmyhra)
* **Maciej** - [sppmacd](https://github.com/sppmacd) * **Maciej** - [sppmacd](https://github.com/sppmacd)
(And many more!) The people listed above have landed more than 100 commits in the project. :^) 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. :^)
## License ## License