system/serenity
system/serenity
1
0
Fork 0
mirror of https://github.com/SerenityOS/serenity synced 2024-07-22 18:46:18 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity
serenity/Documentation
History
Timothy Flynn bbdd624d50 Ladybird: Do not require Qt6 Multimedia if PulseAudio is available 
If PulseAudio is available, the Qt6 audio plugin will never be used. So
let's remove it from the build.

Note that on macOS, the Qt6 audio plugin will be used if the Qt chrome
is enabled. Otherwise, Audio Unit will be used for the AppKit chrome.
2023-11-04 08:36:34 -04: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 CMake: Use a helper file to find GL and EGL in a platform agnostic way 2023-10-31 02:32:58 -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 Ladybird: Do not require Qt6 Multimedia if PulseAudio is available 2023-11-04 08:36:34 -04: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 Documentation: Update WSL QEMU Installation Requirements 2022-12-03 16:04:38 -07: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
CLionCodeStyleSettings.xml Documentation: Recommend CLion code style settings over manual steps 2022-12-03 23:54:48 +00:00
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 Documentation: Remove references to the removed NE2000 driver 2023-01-08 21:51:59 +01:00
HelixConfiguration.md Documentation: Add instructions for configuring the Helix editor 2023-06-03 12:20:40 +02:00
HighDPI.md Playground: Rename the application to GMLPlayground 2022-06-28 21:10:10 +01:00
Links.md Meta+Documentation: Restore links to LibJS website 2023-10-27 07:08:57 +02:00
NetworkBoot.md Kernel: Make i8042 controller initialization sequence more robust 2023-01-06 11:09:56 +01:00
NvimConfiguration.md Documentation: Hide Meta/serenity.sh rebuild-toolchain 2023-09-18 11:13:23 -06:00
Patterns.md Documentation: SerenityOS' => SerenityOS's in Patterns.md 2023-10-26 15:45:50 -06:00
QEMU_Components.png Documentation: Suggest using x86_64 QEMU on Windows 2021-07-10 23:24:45 +02:00
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: Don't pass ^C through the serial console on CI 2023-10-24 13:45:55 +02: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
SpiceIntegration.md Documentation: Fix typo in Spice documentation filename 2023-07-31 20:01:56 +01:00
StringFormatting.md AK+Everywhere: Rename String to DeprecatedString 2022-12-06 08:54:33 +01: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: 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 Meta: Add configuration file for YouCompleteMe 2022-10-27 20:52:39 +01:00
VirtualBox.md Documentation: Update VirtualBox docs memory section 2023-01-06 11:08:58 -07:00
VirtualBox_Creation_Reference.png Documentation: Remove execute bit from image file 2022-08-24 07:29:13 +00:00
VMware.md Documentation: Update VMWare docs memory section 2023-01-06 11:08:58 -07:00
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 Documentation: Add screenshot for WHPX 2021-07-10 23:24:45 +02:00
Xcode_ladybird_Scheme.png Documentation: Add instructions for debugging Ladybird with Xcode 2023-03-28 09:18:50 +01:00

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.

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.