serenity/Documentation
Tim Ledbetter d054116012 Documentation: Replace TRY() example in Patterns.md
The `Menubar::add_menu()` call used in the previous code snippet no
longer returns `ErrorOr`, which defeats the purpose of the example.
2023-09-29 14:05:46 +01:00
..
Browser Documentation: Start documenting LibWeb code style & patterns 2023-03-14 11:31:57 +01:00
HumanInterfaceGuidelines Documentation: Add section on Ellipses to Text.md 2023-05-23 05:59:49 +02:00
Kernel Documentation: Update the kernel development guide on FixedStringBuffer 2023-08-12 11:46:38 -06:00
AdvancedBuildInstructions.md Everywhere: Add RISC-V 64 target to the build system 2023-08-18 08:37:43 -06:00
AndroidStudioConfiguration.md Documentation: Add prerequisites for Android build 2023-09-17 19:22:29 -06:00
BareMetalInstallation.md Documentation: Update information regarding MSIx for NVMe :^) 2023-05-07 21:16:41 +02:00
BuildInstructions.md Documentation: Hide Meta/serenity.sh rebuild-toolchain 2023-09-18 11:13:23 -06:00
BuildInstructionsLadybird.md Documentation: Add Ladybird build instructions for Haiku 2023-09-17 13:38:12 -06:00
BuildInstructionsMacOS.md Meta+Documentation: Require Xcode 14.3 or Clang 14 for the host compiler 2023-05-24 01:20:02 -06:00
BuildInstructionsOther.md Documentation: Correct link to flake.nix in BuildInstructionsOther.md 2023-09-09 08:35:05 -06:00
BuildInstructionsWindows.md
BuildProfilingInstructions.md
CLion_Add_Configuration.png
CLion_Add_Configuration_Existing.png
CLionCodeStyleSettings.xml
CLionConfiguration.md Meta: Rename BuildIt.sh to BuildGNU.sh 2023-06-12 16:22:55 -07:00
CodingStyle.md Meta: Switch to clang-format-16 as the standard formatter 2023-07-08 10:32:56 +01:00
EmacsConfiguration.md Toolchain+Ports: Update GCC to 13.1.0 2023-05-15 07:00:29 +02:00
EventLoop.md Userland: Rename Core::Object to Core::EventReceiver 2023-08-06 20:39:51 +02:00
FAQ.md Documentation: Remove unnecessary answer to non-asked question in FAQ 2023-04-12 14:48:49 +02:00
HardwareCompatibility.md
HelixConfiguration.md Documentation: Add instructions for configuring the Helix editor 2023-06-03 12:20:40 +02:00
HighDPI.md
Links.md Everywhere: Fix a few typos 2023-04-12 19:37:35 +02:00
NetworkBoot.md
NvimConfiguration.md Documentation: Hide Meta/serenity.sh rebuild-toolchain 2023-09-18 11:13:23 -06:00
Patterns.md Documentation: Replace TRY() example in Patterns.md 2023-09-29 14:05:46 +01:00
QEMU_Components.png
QtCreatorConfiguration.md Meta: Switch to clang-format-16 as the standard formatter 2023-07-08 10:32:56 +01:00
README.md Documentation: Fix typo in Spice documentation filename 2023-07-31 20:01:56 +01:00
RunningOnRaspberryPi.md Documentation: Hide Meta/serenity.sh rebuild-toolchain 2023-09-18 11:13:23 -06:00
RunningTests.md Meta+CMake: Remove "image" ninja target in favor of "qemu-image" 2023-03-12 01:48:56 +00:00
SelfHostedRunners.md
SmartPointers.md
SpiceIntegration.md Documentation: Fix typo in Spice documentation filename 2023-07-31 20:01:56 +01:00
StringFormatting.md
Tftpd32_Dhcp.png
Tftpd32_Serving.png
Tftpd32_Tftp.png
TransferringFiles.md Documentation: Rename WebServer_localhost to .jpg 2023-02-01 13:40:37 +00:00
Troubleshooting.md Documentation: Hide Meta/serenity.sh rebuild-toolchain 2023-09-18 11:13:23 -06:00
VimConfiguration.md
VirtualBox.md
VirtualBox_Creation_Reference.png
VMware.md
VSCodeConfiguration.md Documentation: Update VS Code docs for tone, add query-driver directions 2023-03-13 08:00:09 -06:00
WebServer_localhost.jpg Documentation: Rename WebServer_localhost to .jpg 2023-02-01 13:40:37 +00:00
WHPX_Feature.png
Xcode_ladybird_Scheme.png Documentation: Add instructions for debugging Ladybird with Xcode 2023-03-28 09:18:50 +01: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.

A list of useful pages across the web can be found on the link list.

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.