2024-05-30 21:06:21 +00:00
|
|
|
# Ladybird
|
2019-02-08 10:04:23 +00:00
|
|
|
|
2024-07-11 13:59:36 +00:00
|
|
|
[Ladybird](https://ladybird.org) is a truly independent web browser, using a novel engine based on web standards.
|
2024-04-29 19:05:00 +00:00
|
|
|
|
2024-05-30 21:06:21 +00:00
|
|
|
> [!IMPORTANT]
|
|
|
|
|
> Ladybird is in a pre-alpha state, and only suitable for use by developers
|
|
|
|
|
>
|
2019-02-08 10:04:23 +00:00
|
|
|
|
2024-05-30 21:06:21 +00:00
|
|
|
## Features
|
2019-05-28 12:47:24 +00:00
|
|
|
|
2024-05-30 21:06:21 +00:00
|
|
|
We aim to build a complete, usable browser for the modern web.
|
2023-03-28 20:14:02 +00:00
|
|
|
|
2024-05-30 21:06:21 +00:00
|
|
|
Ladybird uses a multi-process architecture with a main UI process, several WebContent renderer processes,
|
2024-06-04 20:40:48 +00:00
|
|
|
an ImageDecoder process, and a RequestServer process.
|
2019-02-08 10:04:23 +00:00
|
|
|
|
2024-05-30 21:06:21 +00:00
|
|
|
Image decoding and network connections are done out of process to be more robust against malicious content.
|
|
|
|
|
Each tab has its own renderer process, which is sandboxed from the rest of the system.
|
2019-03-20 14:52:37 +00:00
|
|
|
|
2024-05-30 21:06:21 +00:00
|
|
|
At the moment, many core library support components are inherited from SerenityOS:
|
2019-02-08 10:04:23 +00:00
|
|
|
|
2024-05-30 21:06:21 +00:00
|
|
|
- LibWeb: Web rendering engine
|
|
|
|
|
- LibJS: JavaScript engine
|
|
|
|
|
- LibWasm: WebAssembly implementation
|
2024-07-06 21:12:39 +00:00
|
|
|
- LibCrypto/LibTLS: Cryptography primitives and Transport Layer Security
|
2024-05-30 21:06:21 +00:00
|
|
|
- LibHTTP: HTTP/1.1 client
|
|
|
|
|
- LibGfx: 2D Graphics Library, Image Decoding and Rendering
|
|
|
|
|
- LibArchive: Archive file format support
|
2024-06-23 13:14:27 +00:00
|
|
|
- LibUnicode: Unicode and locale support
|
2024-08-28 10:08:38 +00:00
|
|
|
- LibMedia: Audio and video playback
|
2024-05-30 21:06:21 +00:00
|
|
|
- LibCore: Event loop, OS abstraction layer
|
|
|
|
|
- LibIPC: Inter-process communication
|
2019-06-07 15:57:03 +00:00
|
|
|
|
2024-05-30 21:06:21 +00: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 19:33:13 +00:00
|
|
|
|
2024-05-30 21:06:21 +00:00
|
|
|
See [build instructions](Documentation/BuildInstructionsLadybird.md) for information on how to build Ladybird.
|
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 19:33:13 +00:00
|
|
|
|
2024-05-30 21:06:21 +00:00
|
|
|
Ladybird runs on Linux, macOS, Windows (with WSL2), and many other \*Nixes.
|
2019-02-08 10:04:23 +00:00
|
|
|
|
2020-05-26 11:12:25 +00:00
|
|
|
## How do I read the documentation?
|
|
|
|
|
|
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 19:33:13 +00:00
|
|
|
Code-related documentation can be found in the [documentation](Documentation/) folder.
|
2020-05-09 07:50:49 +00: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 19:33:13 +00:00
|
|
|
## Get in touch and participate!
|
2019-12-29 15:23:50 +00:00
|
|
|
|
2024-05-30 21:06:21 +00:00
|
|
|
Join [our Discord server](https://discord.gg/nvfjVJ4Svh) to participate in development discussion.
|
2021-04-11 20:04:13 +00:00
|
|
|
|
2024-08-13 14:12:40 +00:00
|
|
|
Please read [Getting started contributing](Documentation/GettingStartedContributing.md) if you plan to contribute to Ladybird for the first time.
|
|
|
|
|
|
2024-07-25 13:29:44 +00:00
|
|
|
Before opening an issue, please see the [issue policy](CONTRIBUTING.md#issue-policy) and the [detailed issue-reporting guidelines](ISSUES.md).
|
2019-02-08 10:04:23 +00:00
|
|
|
|
2024-08-13 14:12:40 +00:00
|
|
|
The full contribution guidelines can be found in [`CONTRIBUTING.md`](CONTRIBUTING.md).
|
2019-06-07 15:57:03 +00:00
|
|
|
|
2019-02-08 10:04:23 +00:00
|
|
|
## License
|
|
|
|
|
|
2024-05-30 21:06:21 +00:00
|
|
|
Ladybird is licensed under a 2-clause BSD license.
|
