2024-05-30 21:06:21 +00:00
# Ladybird Documentation
2022-07-21 14:17:01 +00:00
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 ).
## Building and Running
* [Build Instructions ](BuildInstructions.md )
* [Advanced Build Instructions ](AdvancedBuildInstructions.md )
* [Troubleshooting ](Troubleshooting.md )
* [Running Tests ](RunningTests.md )
* [Setting Up Self-Hosted Runners ](SelfHostedRunners.md )
* [Profiling the Build ](BuildProfilingInstructions.md )
### OS-specific
2024-05-31 06:08:13 +00:00
Make sure to read the basic [Build Instructions ](BuildInstructionsLadybird.md ) first.
2022-07-21 14:17:01 +00:00
* [Building on Windows ](BuildInstructionsWindows.md )
* [Building on macOS ](BuildInstructionsMacOS.md )
* [Building on Linux ](BuildInstructionsOther.md )
## Configuring Editors
* [CLion ](CLionConfiguration.md )
* [Emacs ](EmacsConfiguration.md )
2023-07-15 10:41:13 +00:00
* [Helix ](HelixConfiguration.md )
* [NVim ](NvimConfiguration.md )
2022-07-21 14:17:01 +00:00
* [Qt Creator ](QtCreatorConfiguration.md )
2023-07-15 10:41:13 +00:00
* [Vim ](VimConfiguration.md )
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 )
2023-07-15 10:41:13 +00:00
* [Guidelines for Text in UI ](HumanInterfaceGuidelines/Text.md )
2022-07-21 14:17:01 +00:00
* [EventLoop ](EventLoop.md )
* [Smart Pointers ](SmartPointers.md )
* [String Formatting ](StringFormatting.md )
## Browser/LibWeb
2023-07-15 10:41:13 +00:00
* [Ladybird Browser Build Instructions ](BuildInstructionsLadybird.md )
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 )
2023-03-12 20:03:00 +00:00
* [LibWeb Code Style & Patterns ](Browser/Patterns.md )