Go to file
Linus Groh ac2358ff0d Meta: Add .pre-commit-config.yaml
This pre-commit config is quite simple: all it does for now is running
the already existing Meta/lint-ci.sh script to ensure no changes that
won't pass the CI linting step are committed.
Consequently pass_filenames is set to false, as these scripts will
determine which files to check themselves - should this ever become a
performance bottleneck, we can update them to accept an optional list of
filenames.

It should be noted that using pre-commit for Serenity development is by
no means a requirement, but doing so may decrease the number of CI
builds failing due to forgotten license headers etc. - especially if
you're pushing to `master` directly, rather than going through pull
requests *hint hint*.

For info how to install & use pre-commit, see https://pre-commit.com/.

Fixes #2365.
2020-12-09 21:04:07 +01:00
.github CI: Use Ninja for building (#4293) 2020-12-02 10:45:16 +01:00
AK AK: Fix reading across chunks in DuplexMemoryStream 2020-12-08 23:34:38 +01:00
Applications DisplaySettings: Ensure wallpaper mode is always initialized 2020-12-09 12:46:59 +01:00
Base LibWeb: Naively implement the CSS clear property 2020-12-06 01:45:51 +01:00
Demos AK: Rename new_out to out and new_warn to warn. 2020-11-09 16:21:29 +01:00
DevTools UserspaceEmulator: Implement readlink syscall 2020-12-08 09:37:30 +01:00
Documentation Documentation: Update required GCC version to >= 10 2020-11-07 18:22:18 +01:00
Games Chess: Add ability to export game as PGN file 2020-12-06 15:51:34 +01:00
Kernel Kernel: Flush TLBs concurrently 2020-12-02 23:49:52 +01:00
Libraries LibGUI: Show action shortcut in ToolBarButton tooltip 2020-12-09 15:00:34 +01:00
MenuApplets Clipboard: Remove-unused bpp metadata 2020-12-08 09:37:30 +01:00
Meta Meta+LibHTTP: Fuzz HTTP request parsing 2020-12-02 10:46:40 +01:00
Ports Ports: Add GNU indent 2020-11-09 16:22:52 +01:00
Services LibWeb+WebContent: Add on_load_finish hook to web views 2020-12-08 23:36:19 +01:00
Shell Shell: Actually make shebangs work 2020-12-08 23:34:38 +01:00
Toolchain Toolchain: Trust cache blindly 2020-11-08 09:58:55 +01:00
Userland Userland: Fix overly-eager loop detection in cp (#4368) 2020-12-09 20:56:50 +01:00
.clang-format Meta: Update .clang-format to not indent nested namespaces 2020-03-14 10:10:21 +01:00
.gitattributes Meta: Add .gitattributes file 2020-07-30 17:07:40 +02:00
.gitignore Meta: Add .cache to .gitignore 2020-11-12 10:15:07 +01:00
.pre-commit-config.yaml Meta: Add .pre-commit-config.yaml 2020-12-09 21:04:07 +01:00
.prettierignore Meta: Move prettier config files to the root of the repository 2020-08-24 18:21:33 +02:00
.prettierrc Meta: Move prettier config files to the root of the repository 2020-08-24 18:21:33 +02:00
CMakeLists.txt LibJS: Remove unused {INTERPRETER,VM}_DEBUG 2020-12-06 18:52:43 +01:00
CODE_OF_CONDUCT.md Meta: Move code of conduct (lol) to a separate file 2019-10-23 10:05:06 +02:00
CONTRIBUTING.md Meta: s/Travis/GitHub Actions/ in CONTRIBUTING.md 2020-11-12 10:16:45 +01:00
LICENSE Meta: Tweak license in celebration of 10'000 commits :^) 2020-05-28 19:07:31 +02:00
ReadMe.md Meta: Add OSS-Fuzz badge to ReadMe.md 2020-11-29 12:27:27 +01:00

SerenityOS

Graphical Unix-like operating system for x86 computers.

Build status Fuzzing Status

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.

I (Andreas) regularly post raw hacking sessions and demos on my YouTube channel.

Sometimes I write about the system on my github.io blog.

I'm also on Patreon and GitHub Sponsors if you would like to show some support that way.

Screenshot

Screenshot as of 8ea4375

Kernel features

  • x86 (32-bit) kernel with pre-emptive multi-threading
  • Hardware protections (SMEP, SMAP, UMIP, NX, WP, TSD, ...)
  • IPv4 stack with ARP, TCP, UDP and ICMP protocols
  • ext2 filesystem
  • POSIX signals
  • Purgeable memory
  • /proc filesystem
  • Pseudoterminals (with /dev/pts filesystem)
  • Filesystem notifications
  • CPU and memory profiling
  • SoundBlaster 16 driver
  • VMWare/QEMU mouse integration

System services

  • Launch/session daemon (SystemServer)
  • Compositing window server (WindowServer)
  • Text console manager (TTYServer)
  • DNS client (LookupServer)
  • Network protocols server (ProtocolServer)
  • 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)
  • GUI toolkit (LibGUI)
  • Cross-process communication library (LibIPC)
  • HTML/CSS engine (LibWeb)
  • JavaScript engine (LibJS)
  • Markdown (LibMarkdown)
  • Audio (LibAudio)
  • 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 (LibThread)
  • Transport Layer Security (LibTLS)
  • HTTP and HTTPS (LibHTTP)

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)
  • IRC client
  • Desktop synthesizer (Piano)
  • Various desktop apps & games
  • Color themes

How do I read the documentation?

Man pages are browsable outside of SerenityOS under Base/usr/share/man.

When running SerenityOS you can use man for the terminal interface, or help for the GUI interface.

How do I build and run this?

See the SerenityOS build instructions

Before opening an issue

Please see the issue policy.

Communication hubs

The main hub is #serenityos on the Freenode IRC network.

We also have a project mailing list: serenityos-dev.

Author

Contributors

(And many more!) The people listed above have landed more than 100 commits in the project. :^)

License

SerenityOS is licensed under a 2-clause BSD license.