system/serenity
system/serenity
1
0
Fork 0
mirror of https://github.com/SerenityOS/serenity synced 2024-11-05 17:46:52 +00:00
Code Issues Projects Releases Packages Wiki Activity
serenity/Documentation
History
Timothy Flynn 0d7ea1bd2f CI: Remove the Sonar Cloud and PVS Studio workflow 
Static analysis is great, but these workflows have not worked in a long
time, and no one was looking at the results. Our PVS Studio license and
our Sonar Cloud token have expired. Remove the workflows (at least for
now) so we don't waste CI runners and cache space. If someone is
motivated to revive these, they can revert this commit.
2024-05-11 15:43:18 -04:00
..
Browser Documentation: Describe how to use add_libweb_test.py for Text tests 2024-05-07 16:29:19 -06:00
HumanInterfaceGuidelines Documentation: Add section on Ellipses to Text.md 2023-05-23 05:59:49 +02:00
Kernel Documentation: Update the kernel development guide on FixedStringBuffer 2023-08-12 11:46:38 -06:00
AdvancedBuildInstructions.md CMake: Use a helper file to find GL and EGL in a platform agnostic way 2023-10-31 02:32:58 -06:00
AndroidStudioConfiguration.md Ladybird: Update Android build to work with current LibWebView/LibCore 2024-05-06 09:31:32 -06:00
BareMetalInstallation.md Documentation+Base: Remove old remainders of RAM disk support 2024-05-07 17:02:09 -06:00
BuildInstructions.md Meta: Update Clang version requirement to 17+ 2024-05-10 19:53:15 +02:00
BuildInstructionsLadybird.md Meta: Update Clang version requirement to 17+ 2024-05-10 19:53:15 +02:00
BuildInstructionsMacOS.md CI: Bump Lagom CI builds to gcc-13 and clang-18 2024-04-23 15:37:07 -06:00
BuildInstructionsOther.md nix: Clean up files, use good practices 2024-03-25 14:19:34 -06:00
BuildInstructionsWindows.md Documentation: Update WSL QEMU Installation Requirements 2022-12-03 16:04:38 -07:00
BuildProfilingInstructions.md
CLion_Add_Configuration.png
CLion_Add_Configuration_Existing.png
CLionCodeStyleSettings.xml Documentation: Recommend CLion code style settings over manual steps 2022-12-03 23:54:48 +00:00
CLionConfiguration.md Meta: Rename BuildIt.sh to BuildGNU.sh 2023-06-12 16:22:55 -07:00
CodingStyle.md Meta: Switch to clang-format-18 as the standard formatter 2024-04-24 16:50:01 -04:00
EmacsConfiguration.md Documentation: Recommend disabling clangd's IncludeCleaner feature 2024-02-05 08:04:24 -07:00
EventLoop.md Userland: Rename Core::Object to Core::EventReceiver 2023-08-06 20:39:51 +02:00
FAQ.md Documentation: Expand package manager FAQ with pkg info 2024-01-06 05:01:35 -07:00
HardwareCompatibility.md Documentation: Remove references to the removed NE2000 driver 2023-01-08 21:51:59 +01:00
HelixConfiguration.md Documentation: Recommend disabling clangd's IncludeCleaner feature 2024-02-05 08:04:24 -07:00
HighDPI.md
Links.md CI: Remove the Sonar Cloud and PVS Studio workflow 2024-05-11 15:43:18 -04:00
NvimConfiguration.md Meta+Documentation+Ports: Move from C++20 to C++23 2024-05-06 11:46:28 -06:00
Patterns.md Documentation: SerenityOS' => SerenityOS's in Patterns.md 2023-10-26 15:45:50 -06:00
QEMU_Components.png
QtCreatorConfiguration.md Meta+Documentation+Ports: Move from C++20 to C++23 2024-05-06 11:46:28 -06:00
README.md Documentation+Base: Remove old remainders of RAM disk support 2024-05-07 17:02:09 -06:00
RunningOnRaspberryPi.md Documentation: Hide Meta/serenity.sh rebuild-toolchain 2023-09-18 11:13:23 -06:00
RunningTests.md Meta: Don't pass ^C through the serial console on CI 2023-10-24 13:45:55 +02:00
SelfHostedRunners.md CI: Bump Lagom CI builds to gcc-13 and clang-18 2024-04-23 15:37:07 -06:00
SmartPointers.md
SpiceIntegration.md Documentation: Fix typo in Spice documentation filename 2023-07-31 20:01:56 +01:00
StringFormatting.md Everywhere: Rename {Deprecated => Byte}String 2023-12-17 18:25:10 +03:30
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 CI: Bump Lagom CI builds to gcc-13 and clang-18 2024-04-23 15:37:07 -06:00
VimConfiguration.md Meta: Add configuration file for YouCompleteMe 2022-10-27 20:52:39 +01:00
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 Meta+Documentation+Ports: Move from C++20 to C++23 2024-05-06 11:46:28 -06:00
WebServer_localhost.jpg Documentation: Rename WebServer_localhost to .jpg 2023-02-01 13:40:37 +00:00
WHPX_Feature.png
WritingManPages.md Documentation: Add guidelines for writing manual pages 2024-01-29 05:30:30 -07: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.