Truly independent web browser
Find a file
Ben Wiederhake 4a359b5a42 Meta: Check that local includes can be resolved
If a local include does not point to a file in the repository, it should
be a system include instead. This is now checked on every commit.

While this does introduce significant overhead in terms of percentage,
I think that an additional 10ms on huge commits (or less on smaller
commits) are acceptable:

hyperfine -w1 './Meta/check-style.py AK/*.h AK/*.cpp' # Before
Benchmark 1: ./Meta/check-style.py AK/*.h AK/*.cpp
  Time (mean ± σ):      20.3 ms ±   0.4 ms    [User: 17.1 ms, System: 3.
5 ms]
  Range (min … max):    19.5 ms …  21.6 ms    128 runs

hyperfine -w1 './Meta/check-style.py AK/*.h AK/*.cpp' # After
Benchmark 1: ./Meta/check-style.py AK/*.h AK/*.cpp
  Time (mean ± σ):      32.3 ms ±   0.4 ms    [User: 27.9 ms, System: 4.
4 ms]
  Range (min … max):    31.4 ms …  34.9 ms    91 runs
2023-06-06 23:19:50 +02:00
.devcontainer Meta: Remove unnecessary dot in file name 2023-05-29 13:42:08 +02:00
.github CI: Do not expect test-results.log to exist on AArch64 2023-05-30 11:44:57 +02:00
AK Everywhere: Move global Kernel pattern code to Kernel/Library directory 2023-06-04 21:32:34 +02:00
Base Base: Add .mkv file association to Video Player 2023-06-05 06:56:06 +02:00
Documentation Documentation: Add instructions for configuring the Helix editor 2023-06-03 12:20:40 +02:00
Kernel Kernel/aarch64: Account for reserved VideoCore range in the memory map 2023-06-06 15:45:52 +02:00
Ladybird Toolchain+Ladybird: Declare dependencies in correct nix file 2023-06-04 10:01:34 +02:00
Meta Meta: Check that local includes can be resolved 2023-06-06 23:19:50 +02:00
Ports Ports: Update the Zig port's Serenity type definitions 2023-06-04 05:39:32 +02:00
Tests LibWeb: Support start and end alignment values in flex layout 2023-06-06 21:02:04 +02:00
Toolchain Toolchain+Ladybird: Declare dependencies in correct nix file 2023-06-04 10:01:34 +02:00
Userland Everywhere: Only use local includes where appropriate 2023-06-06 23:19:50 +02:00
.clang-format Meta: Switch to clang-format-15 as the standard formatter 2022-12-03 23:52:23 +00:00
.clang-tidy Meta: Disable the misc-no-recursion check in clang-tidy 2023-03-18 16:34:41 +01:00
.editorconfig Meta: Add .editorconfig 2022-09-10 17:32:55 +01:00
.gitattributes Repository: Protect port patches from CRLF/LF normalization 2022-01-12 01:08:38 +01:00
.gitignore Meta: Ignore Helix's configuration folder 2023-06-03 12:20:40 +02:00
.mailmap Meta: Add mattco98's full name to mailmap 2022-11-23 17:13:49 +00:00
.pre-commit-config.yaml Meta: Add a post-commit commit message linter hook 2021-05-02 16:28:01 +02:00
.prettierignore LibJS: Add DisposableStack{, Prototype, Constructor} 2023-01-23 09:56:50 +00:00
.prettierrc Meta: Move prettier config files to the root of the repository 2020-08-24 18:21:33 +02:00
.ycm_extra_conf.py Meta: Remove i686 references in YCM configuration 2022-12-28 11:53:41 +01:00
azure-pipelines.yml CI: Remove extraneous toolchain job from Azure CI 2022-12-28 15:26:12 -05:00
CMakeLists.txt Toolchain+Ports: Update GCC to 13.1.0 2023-05-15 07:00:29 +02:00
CONTRIBUTING.md Meta: Fix a typo in CONTRIBUTING.md 2023-04-24 16:48:37 +01:00
LICENSE Meta: Update the year range in LICENSE :^) 2023-01-01 09:38:07 +00:00
README.md README: Add a jump section for easy access to documentation 2023-03-28 21:23:45 +01:00
SECURITY.md Meta: Add a security policy 2022-06-29 03:29:27 +00:00

SerenityOS

Graphical Unix-like operating system for x86-64 computers.

GitHub Actions Status Azure DevOps Status Fuzzing Status Sonar Cube Static Analysis Discord

FAQ | Documentation | Build Instructions

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 us, for us, based on the things we like.

You can watch videos of the system being developed on YouTube:

Screenshot

Screenshot as of b36968c.png

Features

  • Modern x86 64-bit kernel with pre-emptive multi-threading
  • Browser with JavaScript, WebAssembly, and more (check the spec compliance for JS, CSS, and Wasm)
  • 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 (WindowServer, LoginServer, AudioServer, WebServer, RequestServer, CrashServer, ...) and modern IPC
  • Good POSIX compatibility (LibC, Shell, syscalls, signals, pseudoterminals, filesystem notifications, standard Unix 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, detailed program analysis with software emulation in UserspaceEmulator, CrashReporter, interactive GUI playground, HexEditor, HackStudio IDE for C++ and more)
  • 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
  • Games (Solitaire, Minesweeper, 2048, chess, Conway's Game of Life, ...) and 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 two hundred ports of popular open-source software, including games, compilers, Unix tools, multimedia apps and more.

How do I read the documentation?

Man pages are available online at man.serenityos.org. These pages are generated from the Markdown source files in Base/usr/share/man and updated automatically.

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 folder.

How do I build and run this?

See the SerenityOS build instructions. Serenity runs on Linux, macOS (aarch64 might be a challenge), Windows (with WSL2) and many other *Nixes with hardware or software virtualization.

Get in touch and participate!

Join our Discord server: SerenityOS Discord

Before opening an issue, please see the issue policy.

A general guide for contributing can be found in CONTRIBUTING.md.

Authors

And many more! See here for a full contributor list. The people listed above have landed more than 100 commits in the project. :^)

License

SerenityOS is licensed under a 2-clause BSD license.