mirrors/serenity
1
0
Fork 0
mirror of https://github.com/SerenityOS/serenity.git synced 2025-01-23 18:02:05 -05:00
Code Issues Projects Releases Packages Wiki Activity
serenity/Documentation
History
Emanuele Torre bb045b3c70 Documentation: Fix markdown syntax 
Use regular ascii backticks instead of U+00B4 (acute accent).
2023-04-25 01:58:05 -06:00
..
Browser Documentation: Start documenting LibWeb code style & patterns 2023-03-14 11:31:57 +01:00
HumanInterfaceGuidelines Documentation: Add HIG document about writing UI text 2023-03-04 00:29:38 +01:00
Kernel Kernel+SystemServer+Base: Introduce the RAMFS filesystem 2023-02-04 15:32:45 -07:00
AdvancedBuildInstructions.md Documentation: Update VS Code docs for tone, add query-driver directions 2023-03-13 08:00:09 -06:00
BareMetalInstallation.md Kernel: Add support for Intel HDA 2023-03-25 21:27:03 +01:00
BuildInstructions.md Documentation: Fix markdown syntax 2023-04-25 01:58:05 -06:00
BuildInstructionsMacOS.md Meta+Documentation: Allow cross-debugging x86_64 Serenity on M1 Macs 2023-03-13 17:02:56 +01:00
BuildInstructionsOther.md
BuildInstructionsWindows.md
BuildProfilingInstructions.md
CLion_Add_Configuration.png
CLion_Add_Configuration_Existing.png
CLionCodeStyleSettings.xml
CLionConfiguration.md Documentation: Fix typo in CLionConfiguration.md 2023-01-08 20:39:59 +01:00
CodingStyle.md Documentation: Document preference for SCREAMING_CASE constants 2023-04-13 15:57:30 +02:00
EmacsConfiguration.md Documentation: Remove i686 support 2022-12-28 11:53:41 +01:00
EventLoop.md
FAQ.md Documentation: Remove unnecessary answer to non-asked question in FAQ 2023-04-12 14:48:49 +02:00
HardwareCompatibility.md Documentation: Remove references to the removed NE2000 driver 2023-01-08 21:51:59 +01:00
HighDPI.md
LadybirdBuildInstructions.md Documentation: Add instructions for debugging Ladybird with Xcode 2023-03-28 09:18:50 +01:00
Links.md Everywhere: Fix a few typos 2023-04-12 19:37:35 +02:00
NetworkBoot.md Kernel: Make i8042 controller initialization sequence more robust 2023-01-06 11:09:56 +01:00
NvimConfiguration.md Documentation: Add query-driver to clangd arguments in NvimConfiguration 2023-03-13 08:00:09 -06:00
Patterns.md Documentation: Document the "Fallible Constructor" pattern 2023-01-26 20:24:16 +00:00
QEMU_Components.png
QtCreatorConfiguration.md Documentation: Update QtCreator setup instructions 2023-01-05 13:20:54 +01:00
README.md Documentation: Start documenting LibWeb code style & patterns 2023-03-14 11:31:57 +01:00
RunningOnRaspberryPi.md
RunningTests.md Meta+CMake: Remove "image" ninja target in favor of "qemu-image" 2023-03-12 01:48:56 +00:00
SelfHostedRunners.md
SmartPointers.md
StringFormatting.md
Tftpd32_Dhcp.png
Tftpd32_Serving.png
Tftpd32_Tftp.png
TransferringFiles.md Documentation: Rename WebServer_localhost to .jpg 2023-02-01 13:40:37 +00:00
Troubleshooting.md Documentation: Add troubleshooting note regarding KVM GDB 2023-02-02 02:02:23 -07:00
VimConfiguration.md
VirtualBox.md Documentation: Update VirtualBox docs memory section 2023-01-06 11:08:58 -07:00
VirtualBox_Creation_Reference.png
VMware.md Documentation: Update VMWare docs memory section 2023-01-06 11:08:58 -07:00
VSCodeConfiguration.md Documentation: Update VS Code docs for tone, add query-driver directions 2023-03-13 08:00:09 -06:00
WebServer_localhost.jpg Documentation: Rename WebServer_localhost to .jpg 2023-02-01 13:40:37 +00:00
WHPX_Feature.png
Xcode_ladybird_Scheme.png Documentation: Add instructions for debugging Ladybird with Xcode 2023-03-28 09:18:50 +01:00

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, 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

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.