serenity/Documentation
Andrew Kaster 77a22268c6 Documentation: Describe extra clang tools built alongside BuildClang.sh
Also rephrase some of the information on updated clang-format binaries
2022-12-10 03:00:24 -07:00
..
Browser Documentation: Update AddNewIDLFile for GC and Exposed changes 2022-10-09 10:14:57 +02:00
Kernel Documentation: Add a note on paths in the kernel development guidelines 2022-12-09 22:59:50 -07:00
AdvancedBuildInstructions.md Documentation: Describe extra clang tools built alongside BuildClang.sh 2022-12-10 03:00:24 -07: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
BuildInstructionsWindows.md Documentation: Update WSL QEMU Installation Requirements 2022-12-03 16:04:38 -07:00
BuildProfilingInstructions.md
CLion_Add_Configuration.png
CLion_Add_Configuration_Existing.png
CLionCodeStyleSettings.xml Documentation: Recommend CLion code style settings over manual steps 2022-12-03 23:54:48 +00:00
CLionConfiguration.md Documentation: Recommend CLion code style settings over manual steps 2022-12-03 23:54:48 +00:00
CodingStyle.md Meta: Update all references of clang-format-14 to clang-format-15 2022-12-04 09:13:24 -07: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
NetworkBoot.md Everywhere: Get rid of the fbdev kernel boot argument remainders 2022-08-14 01:03:23 +01:00
Patterns.md Everywhere: Rename to_{string => deprecated_string}() where applicable 2022-12-06 08:54:33 +01:00
QEMU_Components.png
QtCreatorConfiguration.md Meta: Update all references of clang-format-14 to clang-format-15 2022-12-04 09:13:24 -07:00
README.md
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
StringFormatting.md AK+Everywhere: Rename String to DeprecatedString 2022-12-06 08:54:33 +01:00
Tftpd32_Dhcp.png
Tftpd32_Serving.png
Tftpd32_Tftp.png
TransferringFiles.md
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
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
WHPX_Feature.png

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.