mirror of https://github.com/SerenityOS/serenity synced 2024-07-22 02:26:11 +00:00

History

Linus Groh 8639d8bc21 Meta: Switch to clang-format-15 as the standard formatter The two major changes noticeable on the SerenityOS codebase are: - Much improved support for const placement, clang-format-14 ignored our east-const configuration in various places - Different formatting for requires clauses, now breaking them onto their own line, which helps with readability a bit Current versions of CLion also ship LLVM 15, so the built-in formatting now matches CI formatting again :^)		2022-12-03 23:52:23 +00:00
..
Browser	Documentation: Update AddNewIDLFile for GC and Exposed changes	2022-10-09 10:14:57 +02:00
Kernel	Documentation: Add a document about TmpFS	2022-11-25 14:43:28 -07:00
AdvancedBuildInstructions.md	Meta+Tests: Allow running FLAC spec tests	2022-09-02 23:54:50 +01:00
BareMetalInstallation.md	Everywhere: Get rid of the fbdev kernel boot argument remainders	2022-08-14 01:03:23 +01:00
BuildInstructions.md	Everywhere: Require version >= 12 for GCC host compiler	2022-10-25 23:15:51 +01:00
BuildInstructionsMacOS.md	Documentation: Update macOS build dependencies to gcc-12	2022-11-02 16:58:43 +00:00
BuildInstructionsOther.md	Documentation: Add instructions for building images without root	2022-04-04 12:49:32 +02:00
BuildInstructionsWindows.md	Documentation: Update WSL QEMU Installation Requirements	2022-12-03 16:04:38 -07:00
BuildProfilingInstructions.md
CLion_Add_Configuration.png	Documentation: Add Kernel/Userland quick switch to CLion configuration	2022-04-01 17:39:15 +01:00
CLion_Add_Configuration_Existing.png	Documentation: Add Kernel/Userland quick switch to CLion configuration	2022-04-01 17:39:15 +01:00
CLion_Naming_Convention.png
CLionConfiguration.md	Documentation: Update CLion Configuration to use the x86-64 target	2022-10-12 00:09:51 +02:00
CodingStyle.md	Documentation: Amend comment describing use of "virtual" and "final"	2022-09-06 19:15:54 +00:00
EmacsConfiguration.md	Documentation: Add clang-format variant to EmacsConfiguration.md	2022-08-08 16:36:23 -04:00
EventLoop.md	Everywhere: Fix a variety of typos	2022-09-14 04:46:49 +00:00
FAQ.md	Documentation: Add FAQ regarding MP3 patents	2022-10-15 22:50:33 +02:00
HardwareCompatibility.md
HighDPI.md	Playground: Rename the application to GMLPlayground	2022-06-28 21:10:10 +01:00
NetworkBoot.md	Everywhere: Get rid of the fbdev kernel boot argument remainders	2022-08-14 01:03:23 +01:00
Patterns.md	Everywhere: Fix a variety of typos	2022-09-14 04:46:49 +00:00
QEMU_Components.png
QtCreatorConfiguration.md	Everywhere: Fully remove the separate LibM directory	2022-09-16 16:09:19 +00:00
README.md	Documentation: Add a table of contents for Documentation	2022-07-21 17:35:36 +01:00
RunningOnRaspberryPi.md
RunningTests.md	Everywhere: Get rid of the fbdev kernel boot argument remainders	2022-08-14 01:03:23 +01:00
SelfHostedRunners.md	Meta: Switch to clang-format-15 as the standard formatter	2022-12-03 23:52:23 +00:00
SmartPointers.md	AK: Convert the try_make<T> factory function to use ErrorOr	2022-02-03 23:33:20 +01:00
StringFormatting.md	Documentation: Document string formatting format	2022-01-08 06:18:04 -08:00
Tftpd32_Dhcp.png
Tftpd32_Serving.png
Tftpd32_Tftp.png
TransferringFiles.md	Documentation: Fix Typo in TransferringFiles.md	2022-05-01 18:11:07 +02:00
Troubleshooting.md	Everywhere: Require version >= 12 for GCC host compiler	2022-10-25 23:15:51 +01:00
VimConfiguration.md	Meta: Add configuration file for YouCompleteMe	2022-10-27 20:52:39 +01:00
VirtualBox.md	Documentation: Document setting UUID for VDI image	2022-01-28 19:46:52 +00:00
VirtualBox_Creation_Reference.png	Documentation: Remove execute bit from image file	2022-08-24 07:29:13 +00:00
VMware.md
VSCodeConfiguration.md	Documentation: Give collapsed sections consistent headers	2022-11-03 06:58:19 +00:00
WebServer_localhost.png	Documentation: Document how to transfer files from QEMU to the host	2022-01-10 10:31:54 +01:00
WHPX_Feature.png

README.md

SerenityOS Documentation

Serenity development moves quickly, so some of these might be out of date. Please let us know if something here is wrong, or submit a PR with any additions or corrections! If you have any questions that are not answered here or in the FAQ, you are welcome to ask on Discord.

Building and Running

OS-specific

Make sure to read the basic Build Instructions first.

Running on Hardware

Configuring Editors

Development

File and Data Formats

Browser/LibWeb

Kernel

Applications

Documentation for SerenityOS applications and utilities can be found in the man pages.