mirror of
https://github.com/LadybirdBrowser/ladybird.git
synced 2024-12-05 14:00:32 +00:00
.. | ||
Browser | ||
HumanInterfaceGuidelines | ||
Kernel | ||
AdvancedBuildInstructions.md | ||
AndroidStudioConfiguration.md | ||
BareMetalInstallation.md | ||
BuildInstructions.md | ||
BuildInstructionsLadybird.md | ||
BuildInstructionsMacOS.md | ||
BuildInstructionsOther.md | ||
BuildInstructionsWindows.md | ||
BuildProfilingInstructions.md | ||
CLion_Add_Configuration.png | ||
CLion_Add_Configuration_Existing.png | ||
CLionCodeStyleSettings.xml | ||
CLionConfiguration.md | ||
CodingStyle.md | ||
EmacsConfiguration.md | ||
EventLoop.md | ||
FAQ.md | ||
HardwareCompatibility.md | ||
HelixConfiguration.md | ||
HighDPI.md | ||
Links.md | ||
NetworkBoot.md | ||
NvimConfiguration.md | ||
Patterns.md | ||
QEMU_Components.png | ||
QtCreatorConfiguration.md | ||
README.md | ||
RunningOnRaspberryPi.md | ||
RunningTests.md | ||
SelfHostedRunners.md | ||
SmartPointers.md | ||
SpiceIntegration.md | ||
StringFormatting.md | ||
Tftpd32_Dhcp.png | ||
Tftpd32_Serving.png | ||
Tftpd32_Tftp.png | ||
TransferringFiles.md | ||
Troubleshooting.md | ||
VimConfiguration.md | ||
VirtualBox.md | ||
VirtualBox_Creation_Reference.png | ||
VMware.md | ||
VSCodeConfiguration.md | ||
WebServer_localhost.jpg | ||
WHPX_Feature.png | ||
WritingManPages.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
- Build Instructions
- Advanced Build Instructions
- Troubleshooting
- Running in VirtualBox
- Running in VMware
- Running Tests
- Setting Up Self-Hosted Runners
- Profiling the Build
- Spice Integration
OS-specific
Make sure to read the basic Build Instructions first.
Running on Hardware
Configuring Editors
Development
- How to Contribute
- Coding Style
- Common Patterns
- Guidelines for Text in UI
- Guidelines for writing manual pages
- EventLoop
- High DPI Support
- Smart Pointers
- String Formatting
- How to Transfer Files Out of Serenity
File and Data Formats
- Application Files (.af)
- Bitmap Fonts (.font)
- Clipboard data
- Drag-and-drop data
- GUI Markup Language (.gml)
- HackStudio Post-Create Scripts (.postcreate)
- Inter-Process Communication protocol (.ipc)
Browser/LibWeb
- Ladybird Browser Build Instructions
- General Architecture
- LibWeb: From Loading to Painting
- How to Add an IDL File
- LibWeb Code Style & Patterns
Kernel
- AHCI Locking
- ProcFS Indexing
- RAMFS
- IOWindow
- Graphics Subsystem
- Kernel Development Patterns & Guidelines
Applications
Documentation for SerenityOS applications and utilities can be found in the man pages.