serenity/Documentation/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](FAQ.md), you are welcome to ask on [Discord](../README.md#get-in-touch-and-participate).

A list of useful pages across the web can be found on [the link list](Links.md).

## Building and Running
* [Build Instructions](BuildInstructions.md)
* [Advanced Build Instructions](AdvancedBuildInstructions.md)
* [Troubleshooting](Troubleshooting.md)
* [Running in VirtualBox](VirtualBox.md)
* [Running in VMware](VMware.md)
* [Running Tests](RunningTests.md)
* [Setting Up Self-Hosted Runners](SelfHostedRunners.md)
* [Profiling the Build](BuildProfilingInstructions.md)
* [Spice Integration](SpiceIntegration.md)

### OS-specific
Make sure to read the basic [Build Instructions](BuildInstructions.md) first.
* [Building on Windows](BuildInstructionsWindows.md)
* [Building on macOS](BuildInstructionsMacOS.md)
* [Building on Linux](BuildInstructionsOther.md)

### Running on Hardware
* [Bare Metal Installation](BareMetalInstallation.md)
* [Running On Raspberry Pi](RunningOnRaspberryPi.md)
* [Known Hardware Compatibility](HardwareCompatibility.md)

## Configuring Editors
* [CLion](CLionConfiguration.md)
* [Emacs](EmacsConfiguration.md)
* [Helix](HelixConfiguration.md)
* [NVim](NvimConfiguration.md)
* [Qt Creator](QtCreatorConfiguration.md)
* [Vim](VimConfiguration.md)
* [VS Code](VSCodeConfiguration.md)

## Development
* [How to Contribute](../CONTRIBUTING.md)
* [Coding Style](CodingStyle.md)
* [Common Patterns](Patterns.md)
* [Guidelines for Text in UI](HumanInterfaceGuidelines/Text.md)
* [Guidelines for writing manual pages](WritingManPages.md)
* [EventLoop](EventLoop.md)
* [High DPI Support](HighDPI.md)
* [Smart Pointers](SmartPointers.md)
* [String Formatting](StringFormatting.md)
* [How to Transfer Files Out of Serenity](TransferringFiles.md)

### File and Data Formats
* [Application Files (.af)](../Base/usr/share/man/man5/af.md)
* [Bitmap Fonts (.font)](../Base/usr/share/man/man5/font.md)
* [Clipboard data](../Base/usr/share/man/man5/clipboard.md)
* [Drag-and-drop data](../Base/usr/share/man/man5/drag-and-drop.md)
* [GUI Markup Language (.gml)](../Base/usr/share/man/man5/GML.md)
* [HackStudio Post-Create Scripts (.postcreate)](../Base/usr/share/man/man5/postcreate.md)
* [Inter-Process Communication protocol (.ipc)](../Base/usr/share/man/man4/ipc.md)

## Browser/LibWeb
* [Ladybird Browser Build Instructions](BuildInstructionsLadybird.md)
* [General Architecture](Browser/ProcessArchitecture.md)
* [LibWeb: From Loading to Painting](Browser/LibWebFromLoadingToPainting.md)
* [How to Add an IDL File](Browser/AddNewIDLFile.md)
* [LibWeb Code Style & Patterns](Browser/Patterns.md)

## Kernel
* [AHCI Locking](Kernel/AHCILocking.md)
* [ProcFS Indexing](Kernel/ProcFSIndexing.md)
* [RAMFS](Kernel/RAMFS.md)
* [IOWindow](Kernel/IOWindow.md)
* [Graphics Subsystem](Kernel/GraphicsSubsystem.md)
* [Kernel Development Patterns & Guidelines](Kernel/DevelopmentGuidelines.md)

## Applications
Documentation for SerenityOS applications and utilities can be found in [the man pages](https://man.serenityos.org/).
Documentation: Add a table of contents for Documentation 2022-07-21 14:17:01 +00: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](FAQ.md), you are welcome to ask on [Discord](../README.md#get-in-touch-and-participate).`

Documentation: Add a link list The link list tries to collect all links from the website, BenW's link list <https://benwiederhake.github.io/serenity-fixmes/index.html#links> and the unofficial wiki <https://wiki.serenityos.net/links.html> into one sorted and expanded list, so that hopefully noone has difficulty searching for serenity pages in the future :^) 2023-01-20 23:01:44 +00:00			`A list of useful pages across the web can be found on [the link list](Links.md).`

Documentation: Add a table of contents for Documentation 2022-07-21 14:17:01 +00:00			`## Building and Running`
			`* [Build Instructions](BuildInstructions.md)`
			`* [Advanced Build Instructions](AdvancedBuildInstructions.md)`
			`* [Troubleshooting](Troubleshooting.md)`
			`* [Running in VirtualBox](VirtualBox.md)`
			`* [Running in VMware](VMware.md)`
			`* [Running Tests](RunningTests.md)`
			`* [Setting Up Self-Hosted Runners](SelfHostedRunners.md)`
			`* [Profiling the Build](BuildProfilingInstructions.md)`
Documentation: Fix typo in Spice documentation filename 2023-07-31 19:01:25 +00:00			`* [Spice Integration](SpiceIntegration.md)`
Documentation: Add a table of contents for Documentation 2022-07-21 14:17:01 +00:00
			`### OS-specific`
			`Make sure to read the basic [Build Instructions](BuildInstructions.md) first.`
			`* [Building on Windows](BuildInstructionsWindows.md)`
			`* [Building on macOS](BuildInstructionsMacOS.md)`
			`* [Building on Linux](BuildInstructionsOther.md)`

			`### Running on Hardware`
			`* [Bare Metal Installation](BareMetalInstallation.md)`
			`* [Running On Raspberry Pi](RunningOnRaspberryPi.md)`
			`* [Known Hardware Compatibility](HardwareCompatibility.md)`

			`## Configuring Editors`
			`* [CLion](CLionConfiguration.md)`
			`* [Emacs](EmacsConfiguration.md)`
Documentation: Add links of all docs that aren't mentioned anywhere 2023-07-15 10:41:13 +00:00			`* [Helix](HelixConfiguration.md)`
			`* [NVim](NvimConfiguration.md)`
Documentation: Add a table of contents for Documentation 2022-07-21 14:17:01 +00:00			`* [Qt Creator](QtCreatorConfiguration.md)`
Documentation: Add links of all docs that aren't mentioned anywhere 2023-07-15 10:41:13 +00:00			`* [Vim](VimConfiguration.md)`
Documentation: Add a table of contents for Documentation 2022-07-21 14:17:01 +00:00			`* [VS Code](VSCodeConfiguration.md)`

			`## Development`
			`* [How to Contribute](../CONTRIBUTING.md)`
			`* [Coding Style](CodingStyle.md)`
			`* [Common Patterns](Patterns.md)`
Documentation: Add links of all docs that aren't mentioned anywhere 2023-07-15 10:41:13 +00:00			`* [Guidelines for Text in UI](HumanInterfaceGuidelines/Text.md)`
Documentation: Add guidelines for writing manual pages Based on current consensus and the way our manpages are written. 2024-01-25 12:32:58 +00:00			`* [Guidelines for writing manual pages](WritingManPages.md)`
Documentation: Add a table of contents for Documentation 2022-07-21 14:17:01 +00:00			`* [EventLoop](EventLoop.md)`
			`* [High DPI Support](HighDPI.md)`
			`* [Smart Pointers](SmartPointers.md)`
			`* [String Formatting](StringFormatting.md)`
			`* [How to Transfer Files Out of Serenity](TransferringFiles.md)`

			`### File and Data Formats`
			`* [Application Files (.af)](../Base/usr/share/man/man5/af.md)`
			`* [Bitmap Fonts (.font)](../Base/usr/share/man/man5/font.md)`
			`* [Clipboard data](../Base/usr/share/man/man5/clipboard.md)`
			`* [Drag-and-drop data](../Base/usr/share/man/man5/drag-and-drop.md)`
			`* [GUI Markup Language (.gml)](../Base/usr/share/man/man5/GML.md)`
			`* [HackStudio Post-Create Scripts (.postcreate)](../Base/usr/share/man/man5/postcreate.md)`
			`* [Inter-Process Communication protocol (.ipc)](../Base/usr/share/man/man4/ipc.md)`

			`## Browser/LibWeb`
Documentation: Add links of all docs that aren't mentioned anywhere 2023-07-15 10:41:13 +00:00			`* [Ladybird Browser Build Instructions](BuildInstructionsLadybird.md)`
Documentation: Add a table of contents for Documentation 2022-07-21 14:17:01 +00:00			`* [General Architecture](Browser/ProcessArchitecture.md)`
			`* [LibWeb: From Loading to Painting](Browser/LibWebFromLoadingToPainting.md)`
			`* [How to Add an IDL File](Browser/AddNewIDLFile.md)`
Documentation: Start documenting LibWeb code style & patterns 2023-03-12 20:03:00 +00:00			`* [LibWeb Code Style & Patterns](Browser/Patterns.md)`
Documentation: Add a table of contents for Documentation 2022-07-21 14:17:01 +00:00
			`## Kernel`
			`* [AHCI Locking](Kernel/AHCILocking.md)`
			`* [ProcFS Indexing](Kernel/ProcFSIndexing.md)`
Documentation: Add links of all docs that aren't mentioned anywhere 2023-07-15 10:41:13 +00:00			`* [RAMFS](Kernel/RAMFS.md)`
			`* [IOWindow](Kernel/IOWindow.md)`
			`* [Graphics Subsystem](Kernel/GraphicsSubsystem.md)`
			`* [Kernel Development Patterns & Guidelines](Kernel/DevelopmentGuidelines.md)`
Documentation: Add a table of contents for Documentation 2022-07-21 14:17:01 +00:00
			`## Applications`
			`Documentation for SerenityOS applications and utilities can be found in [the man pages](https://man.serenityos.org/).`