beenull/ladybird
1
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2024-11-25 17:10:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7
ladybird/README.md

155 lines
6.7 KiB
Markdown
Raw Normal View History

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
Meta: Add Azure DevOps badge to README
2021-08-17 16:51:41 +00: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)
Meta: Add OSS-Fuzz badge to ReadMe.md https://google.github.io/oss-fuzz/getting-started/new-project-guide/#status-badge > Once your project has started building, we’d love it if you added our > badge in your project’s README. This allows you to see bugs found by > your OSS-Fuzz integration at a glance.
2020-11-29 11:24:00 +00:00
[![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)
Everywhere: Use new discord invite url :^) Replaces all instances of the previous discord invite link with a shiny new vanity url.
2021-06-14 21:23:12 +00:00
[![Discord](https://img.shields.io/discord/830522505605283862.svg?logo=discord&logoColor=white&logoWidth=20&labelColor=7289DA&label=Discord&color=17cf48)](https://discord.gg/serenityos)
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
README+Meta: Update the screenshot :^)
2021-08-18 11:47:27 +00:00
![Screenshot as of b36968c.png](https://raw.githubusercontent.com/SerenityOS/serenity/master/Meta/screenshot-b36968c.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: Add x86_64 to supported architectures in README
2021-07-31 20:20:38 +00:00
* x86 (32-bit) and x86_64 (64-bit) kernel with pre-emptive multi-threading
Meta: Edit the ReadMe a little bit :^)
2020-02-06 14:50:52 +00:00
* 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)
Services: Rename ProtocolServer to RequestServer The current ProtocolServer was really only used for requests, and with the recent introduction of the WebSocket service, long-lasting connections with another server are not part of it. To better reflect this, this commit renames it to RequestServer. This commit also changes the existing 'protocol' portal to 'request', the existing 'protocol' user and group to 'request', and most mentions of the 'download' aspect of the request to 'request' when relevant, to make everything consistent across the system. Note that LibProtocol still exists as-is, but the more generic Client class and the more specific Download class have both been renamed to a more accurate RequestClient and Request to match the new names. This commit only change names, not behaviors.
2021-04-23 20:45:52 +00:00
* Network protocols server (RequestServer and WebSocket)
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)
Meta: Add `LibGL` to README :^) Think this is fleshed out and cool enough to warrant being in the README :^)
2021-05-28 16:47:38 +00:00
* OpenGL 1.x compatible library (LibGL)
Meta: Edit the ReadMe a little bit :^)
2020-02-06 14:50:52 +00:00
* 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)
Libraries: Add LibDSP LibDSP is a library for digital signal processing, and is primarily intended to support the future DAW version of Piano.
2021-08-27 14:18:11 +00:00
* Digital Signal Processing/Synthesizer Chains (LibDSP)
Meta: Edit the ReadMe a little bit :^)
2020-02-06 14:50:52 +00:00
* 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)
Meta: Fixed small typo in readme (#3373)
2020-09-01 11:49:16 +00:00
* ELF file handling (LibELF)
Meta: Add more libraries to ReadMe.md
2020-03-14 17:03:41 +00:00
* POSIX threading (LibPthread)
Userland: Rename LibThread => LibThreading Also rename the "LibThread" namespace to "Threading"
2021-05-22 16:47:42 +00:00
* Higher-level threading (LibThreading)
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: Add LibIMAP and Mail to the list of libraries and features
2021-07-23 22:11:08 +00:00
* IMAP (LibIMAP)
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)
* Desktop synthesizer (Piano)
Meta: Add LibIMAP and Mail to the list of libraries and features
2021-07-23 22:11:08 +00:00
* E-mail client (Mail)
Meta: Edit the ReadMe a little bit :^)
2020-02-06 14:50:52 +00:00
* 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?
Meta: Mention man.serenityos.org in the README :^)
2021-05-04 20:52:46 +00:00
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.
Meta: Add github link to the man pages from ReadMe.md Closes #2039
2020-05-26 11:12:25 +00:00
Documentation: Fix "GUI interface" wording "GUI" = graphical user interface "GUI interface" = graphical user interface interface :^)
2021-04-25 21:49:54 +00:00
When running SerenityOS you can use `man` for the terminal interface, or `help` for the GUI.
Meta: Add github link to the man pages from ReadMe.md Closes #2039
2020-05-26 11:12:25 +00:00
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: Fix broken FAQ link in README
2021-05-09 07:15:56 +00:00
FAQ: [Frequently Asked Questions](https://github.com/SerenityOS/serenity/blob/master/Documentation/FAQ.md)
Documentation: Update FAQ a bit and move it into Documentation/ This was hiding on the serenityos.org website previously, where not many people found it. Let's put it in a more natural location, and also make sure to link to it from the README.
2021-05-05 18:03:02 +00:00
Meta: Remove the (not really used) mailing list from ReadMe.md We ended up not using it much so let's not link to it.
2021-04-09 13:24:15 +00:00
## Get in touch
Meta: Update ReadMe and move build instructions to a separate document
2019-12-29 15:23:50 +00:00
Everywhere: Use new discord invite url :^) Replaces all instances of the previous discord invite link with a shiny new vanity url.
2021-06-14 21:23:12 +00:00
Join our Discord server: [SerenityOS Discord](https://discord.gg/serenityos)
Meta: Add a link to the SerenityOS Discord server in README.md
2021-04-11 20:04:13 +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)
Meta: Add Paul Scharnofske to the contributors list :^)
2020-09-14 19:17:12 +00:00
* **Paul Scharnofske** - [asynts](https://github.com/asynts)
Meta: Add Itamar Shenhar to the contributors list :^)
2020-09-20 17:55:36 +00:00
* **Itamar Shenhar** - [itamar8910](https://github.com/itamar8910)
Meta: Add Luke Wilde to the contributors list :^)
2020-12-11 22:29:30 +00:00
* **Luke Wilde** - [Lubrsi](https://github.com/Lubrsi)
Meta: Add Brendan Coles to the contributors list :^)
2020-12-24 09:47:36 +00:00
* **Brendan Coles** - [bcoles](https://github.com/bcoles)
Meta: Add Andrew Kaster to the contributors list :^)
2021-01-13 10:26:16 +00:00
* **Andrew Kaster** - [ADKaster](https://github.com/ADKaster)
Meta: Add thankyouverycool to the contributors list :^)
2021-03-30 08:52:21 +00:00
* **thankyouverycool** - [thankyouverycool](https://github.com/thankyouverycool)
Meta: Add Idan Horowitz to the contributors list :^)
2021-04-17 09:25:22 +00:00
* **Idan Horowitz** - [IdanHo](https://github.com/IdanHo)
Meta: Add Gunnar Beutner to the contributors list :^)
2021-04-18 09:33:03 +00:00
* **Gunnar Beutner** - [gunnarbeutner](https://github.com/gunnarbeutner)
Meta: Add Tim Flynn to the contributors list :^)
2021-04-24 12:34:18 +00:00
* **Tim Flynn** - [trflynn89](https://github.com/trflynn89)
Meta: Add Jean-Baptiste Boric to contributors list :^)
2021-05-24 11:33:52 +00:00
* **Jean-Baptiste Boric** - [boricj](https://github.com/boricj)
Meta: Add Stephan Unverwerth to the contributors list :^)
2021-05-24 19:05:49 +00:00
* **Stephan Unverwerth** - [sunverwerth](https://github.com/sunverwerth)
Meta: Add Max Wipfli to the contributors list :^)
2021-06-11 10:47:08 +00:00
* **Max Wipfli** - [MaxWipfli](https://github.com/MaxWipfli)
Meta: Add Daniel Bertalan to the contributors list :^)
2021-07-08 08:38:32 +00:00
* **Daniel Bertalan** - [BertalanD](https://github.com/BertalanD)
Meta: Add Jelle Raaijmakers to the contributors list :^)
2021-07-31 09:21:06 +00:00
* **Jelle Raaijmakers** - [GMTA](https://github.com/GMTA)
Meta: Add Sam Atkins to the contributors list :^)
2021-07-31 09:22:28 +00:00
* **Sam Atkins** - [AtkinsSJ](http://github.com/AtkinsSJ)
Meta: Add Tobias Christiansen to the contributors list :^)
2021-08-07 22:49:42 +00:00
* **Tobias Christiansen** - [TobyAsE](https://github.com/TobyAsE)
Meta: Add Lenny Maiorani to the contributors list :^)
2021-08-13 13:17:14 +00:00
* **Lenny Maiorani** - [ldm5180](https://github.com/ldm5180)
Meta: Add sin-ack to the contributors list :^)
2021-08-15 13:55:44 +00:00
* **sin-ack** - [sin-ack](https://github.com/sin-ack)
Meta: Add Jesse Buhagiar to the contributors list :^)
2021-08-25 22:25:04 +00:00
* **Jesse Buhagiar** - [Quaker762](https://github.com/Quaker762)
Meta: Add Peter Elliott to the contributors list :^)
2021-08-31 14:57:01 +00:00
* **Peter Elliott** - [Petelliott](https://github.com/Petelliott)
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.
Reference in a new issue Copy permalink