ladybird/Documentation/README.md

Ladybird 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

• Build Instructions
• Advanced Build Instructions
• Troubleshooting
• Running Tests
• Setting Up Self-Hosted Runners
• Profiling the Build

OS-specific

Make sure to read the basic Build Instructions first.

• Building on Windows
• Building on macOS
• Building on Linux

Configuring Editors

• CLion
• Emacs
• Helix
• NVim
• Qt Creator
• Vim
• VS Code

Development

• How to Contribute
• Coding Style
• Common Patterns
• Guidelines for Text in UI
• EventLoop
• Smart Pointers
• String Formatting

Browser/LibWeb

• Ladybird Browser Build Instructions
• General Architecture
• LibWeb: From Loading to Painting
• How to Add an IDL File
• LibWeb Code Style & Patterns