serenity/Documentation
2022-07-21 17:35:36 +01:00
..
Browser LibWeb: Rename FormattingState to LayoutState 2022-07-17 14:11:36 +02:00
Kernel Documentation: Fix grammar-o in ProcFSIndexing.md 2021-10-01 01:06:40 +01:00
AdvancedBuildInstructions.md Meta+Userland: Add jakt as an optional Lagom Tool 2022-05-23 23:05:45 +02:00
BareMetalInstallation.md Documentation: Update BareMetalInstallation's storage support section 2022-02-02 18:26:59 +01:00
BuildInstructions.md Meta+Documentation: Bump required QEMU version 2022-05-24 06:30:57 -04:00
BuildInstructionsMacOS.md Documentation: Add information on MacOS build prerequisites 2022-07-04 05:52:31 +00:00
BuildInstructionsOther.md Documentation: Add instructions for building images without root 2022-04-04 12:49:32 +02:00
BuildInstructionsWindows.md Documentation: Clarify Windows build instructions 2021-09-10 14:05:25 +00:00
BuildProfilingInstructions.md Documentation: Add BuildProfilingInstructions.md 2021-07-30 20:51:11 +02:00
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 Documentation: Add preferred coding style options to CLion configuration 2021-07-27 22:49:41 +02:00
CLionConfiguration.md Documentation: Add Kernel/Userland quick switch to CLion configuration 2022-04-01 17:39:15 +01:00
CodingStyle.md Documentation: Specify that no new code should contain C-style casts 2022-05-29 20:36:16 +01:00
EmacsConfiguration.md Documentation: Bump compiler version to 12.1.0 in include paths 2022-06-30 13:16:40 +02:00
EventLoop.md Documentation: Document how the event loop works & what it does 2022-05-03 23:04:11 +02:00
FAQ.md Docs: FAQ: Improve grammar in 2 paragraphs 2022-07-05 20:07:57 +00:00
HardwareCompatibility.md Documentation: Add the new supported RTL8168 variants to the list 2021-09-18 17:49:24 +03:00
HighDPI.md Playground: Rename the application to GMLPlayground 2022-06-28 21:10:10 +01:00
NetworkBoot.md Everywhere: Fix spelling mistakes 2022-01-07 15:44:42 +01:00
Patterns.md Userland: Rename WindowServerConnection=>ConnectionToWindowServer 2022-02-25 22:35:12 +01:00
QEMU_Components.png Documentation: Suggest using x86_64 QEMU on Windows 2021-07-10 23:24:45 +02:00
QtCreatorConfiguration.md Documentation: Rename UsingQtCreator.md 2022-07-21 17:35:36 +01:00
README.md Documentation: Add a table of contents for Documentation 2022-07-21 17:35:36 +01:00
RunningOnRaspberryPi.md Documentation: Tweak RunningOnRaspberryPi a bit 2021-10-21 20:01:34 +01:00
RunningTests.md Documentation: Add ninja command to example 2022-05-25 23:50:57 +01:00
SelfHostedRunners.md Meta: Switch to clang-format-14 as the standard formatter 2022-04-01 21:24:45 +01: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 Documentation: Add RunningOnRaspberryPi page 2021-10-16 00:36:51 +01:00
Tftpd32_Serving.png Documentation: Add RunningOnRaspberryPi page 2021-10-16 00:36:51 +01:00
Tftpd32_Tftp.png Documentation: Add RunningOnRaspberryPi page 2021-10-16 00:36:51 +01:00
TransferringFiles.md Documentation: Fix Typo in TransferringFiles.md 2022-05-01 18:11:07 +02:00
Troubleshooting.md Meta+CI+Documentation: Bump host gcc requirement up to gcc 11 2022-01-07 11:02:30 +01:00
VirtualBox.md Documentation: Document setting UUID for VDI image 2022-01-28 19:46:52 +00:00
VirtualBox_Creation_Reference.png Documentation: Add an installation guide for VirtualBox 2020-08-05 10:52:48 +02:00
VMware.md Documentation: Reorganize the build documentation 2021-07-10 23:24:45 +02:00
VSCodeConfiguration.md Everywhere: Fully remove the separate LibPthread directory 2022-07-19 11:00:35 +01: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 Documentation: Add screenshot for WHPX 2021-07-10 23:24:45 +02:00

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.