RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-10-31 08:32:43 +00:00
Code Issues Activity Actions
serenity/Documentation
History
0xxFF c4bc889346 Documentation: Adjust default TARGET to x86_64 in the documentation
2022-12-19 09:00:34 -05:00
..
Browser Documentation: Update AddNewIDLFile for GC and Exposed changes 2022-10-09 10:14:57 +02:00
Kernel Documentation: Add a note on paths in the kernel development guidelines 2022-12-09 22:59:50 -07:00
AdvancedBuildInstructions.md Documentation: Describe extra clang tools built alongside BuildClang.sh 2022-12-10 03:00:24 -07:00
BareMetalInstallation.md Everywhere: Get rid of the fbdev kernel boot argument remainders 2022-08-14 01:03:23 +01:00
BuildInstructions.md Documentation: Adjust default TARGET to x86_64 in the documentation 2022-12-19 09:00:34 -05:00
BuildInstructionsMacOS.md Documentation: Explain CMake 3.25.x requirement 2022-12-17 22:21:43 -07:00
BuildInstructionsOther.md Documentation: Add instructions for building images without root 2022-04-04 12:49:32 +02:00
BuildInstructionsWindows.md Documentation: Update WSL QEMU Installation Requirements 2022-12-03 16:04:38 -07:00
BuildProfilingInstructions.md Documentation: Add BuildProfilingInstructions.md 2021-07-30 20:51:11 +02:00
CLion_Add_Configuration.png Documentation: Add Kernel/Userland quick switch to CLion configuration 2022-04-01 17:39:15 +01:00
CLion_Add_Configuration_Existing.png Documentation: Add Kernel/Userland quick switch to CLion configuration 2022-04-01 17:39:15 +01:00
CLionCodeStyleSettings.xml Documentation: Recommend CLion code style settings over manual steps 2022-12-03 23:54:48 +00:00
CLionConfiguration.md Documentation: Recommend CLion code style settings over manual steps 2022-12-03 23:54:48 +00:00
CodingStyle.md Meta: Update all references of clang-format-14 to clang-format-15 2022-12-04 09:13:24 -07:00
EmacsConfiguration.md Documentation: Add clang-format variant to EmacsConfiguration.md 2022-08-08 16:36:23 -04:00
EventLoop.md Everywhere: Fix a variety of typos 2022-09-14 04:46:49 +00:00
FAQ.md Documentation: Add FAQ regarding MP3 patents 2022-10-15 22:50:33 +02:00
HardwareCompatibility.md Documentation: Add the new supported RTL8168 variants to the list 2021-09-18 17:49:24 +03:00
HighDPI.md Playground: Rename the application to GMLPlayground 2022-06-28 21:10:10 +01:00
NetworkBoot.md Everywhere: Get rid of the fbdev kernel boot argument remainders 2022-08-14 01:03:23 +01:00
Patterns.md Everywhere: Rename to_{string => deprecated_string}() where applicable 2022-12-06 08:54:33 +01:00
QEMU_Components.png Documentation: Suggest using x86_64 QEMU on Windows 2021-07-10 23:24:45 +02:00
QtCreatorConfiguration.md Meta: Update all references of clang-format-14 to clang-format-15 2022-12-04 09:13:24 -07:00
README.md Documentation: Add a table of contents for Documentation 2022-07-21 17:35:36 +01:00
RunningOnRaspberryPi.md Documentation: Tweak RunningOnRaspberryPi a bit 2021-10-21 20:01:34 +01:00
RunningTests.md Everywhere: Get rid of the fbdev kernel boot argument remainders 2022-08-14 01:03:23 +01:00
SelfHostedRunners.md Meta: Switch to clang-format-15 as the standard formatter 2022-12-03 23:52:23 +00:00
SmartPointers.md AK: Convert the try_make<T> factory function to use ErrorOr 2022-02-03 23:33:20 +01:00
StringFormatting.md AK+Everywhere: Rename String to DeprecatedString 2022-12-06 08:54:33 +01:00
Tftpd32_Dhcp.png Documentation: Add RunningOnRaspberryPi page 2021-10-16 00:36:51 +01:00
Tftpd32_Serving.png Documentation: Add RunningOnRaspberryPi page 2021-10-16 00:36:51 +01:00
Tftpd32_Tftp.png Documentation: Add RunningOnRaspberryPi page 2021-10-16 00:36:51 +01:00
TransferringFiles.md Documentation: Fix Typo in TransferringFiles.md 2022-05-01 18:11:07 +02:00
Troubleshooting.md Everywhere: Require version >= 12 for GCC host compiler 2022-10-25 23:15:51 +01:00
VimConfiguration.md Meta: Add configuration file for YouCompleteMe 2022-10-27 20:52:39 +01:00
VirtualBox.md Documentation: Document setting UUID for VDI image 2022-01-28 19:46:52 +00:00
VirtualBox_Creation_Reference.png Documentation: Remove execute bit from image file 2022-08-24 07:29:13 +00:00
VMware.md Documentation: Reorganize the build documentation 2021-07-10 23:24:45 +02:00
VSCodeConfiguration.md Documentation: Give collapsed sections consistent headers 2022-11-03 06:58:19 +00:00
WebServer_localhost.png Documentation: Document how to transfer files from QEMU to the host 2022-01-10 10:31:54 +01:00
WHPX_Feature.png Documentation: Add screenshot for WHPX 2021-07-10 23:24:45 +02: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.

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.