From 25441e225040fd3d49d0f8102493682ab3602e62 Mon Sep 17 00:00:00 2001 From: Sam Atkins Date: Tue, 22 Oct 2024 15:24:25 +0100 Subject: [PATCH] Documentation: Move editor configuration guides into a subdirectory This makes them a bit easier to find, and also stops them cluttering up the main documentation. --- Documentation/BuildInstructionsLadybird.md | 2 +- .../AndroidStudioConfiguration.md | 0 .../CLionCodeStyleSettings.xml | 0 .../CLionConfiguration.md | 2 +- .../EmacsConfiguration.md | 0 .../HelixConfiguration.md | 0 .../NvimConfiguration.md | 0 .../QtCreatorConfiguration.md | 4 ++-- .../VSCodeConfiguration.md | 0 .../{ => EditorConfiguration}/VimConfiguration.md | 0 Documentation/README.md | 15 ++++++++------- 11 files changed, 12 insertions(+), 11 deletions(-) rename Documentation/{ => EditorConfiguration}/AndroidStudioConfiguration.md (100%) rename Documentation/{ => EditorConfiguration}/CLionCodeStyleSettings.xml (100%) rename Documentation/{ => EditorConfiguration}/CLionConfiguration.md (97%) rename Documentation/{ => EditorConfiguration}/EmacsConfiguration.md (100%) rename Documentation/{ => EditorConfiguration}/HelixConfiguration.md (100%) rename Documentation/{ => EditorConfiguration}/NvimConfiguration.md (100%) rename Documentation/{ => EditorConfiguration}/QtCreatorConfiguration.md (93%) rename Documentation/{ => EditorConfiguration}/VSCodeConfiguration.md (100%) rename Documentation/{ => EditorConfiguration}/VimConfiguration.md (100%) diff --git a/Documentation/BuildInstructionsLadybird.md b/Documentation/BuildInstructionsLadybird.md index 5401097a153..c05d61d0007 100644 --- a/Documentation/BuildInstructionsLadybird.md +++ b/Documentation/BuildInstructionsLadybird.md @@ -176,7 +176,7 @@ pkgman install cmake cmd:python3 ninja openal_devel qt6_base_devel qt6_multimedi ### Android: -On a Unix-like platform, install the prerequisites for that platform and then see the [Android Studio guide](AndroidStudioConfiguration.md). +On a Unix-like platform, install the prerequisites for that platform and then see the [Android Studio guide](EditorConfiguration/AndroidStudioConfiguration.md). Or, download a version of Gradle >= 8.0.0, and run the ``gradlew`` program in ``Ladybird/Android`` ## Build steps diff --git a/Documentation/AndroidStudioConfiguration.md b/Documentation/EditorConfiguration/AndroidStudioConfiguration.md similarity index 100% rename from Documentation/AndroidStudioConfiguration.md rename to Documentation/EditorConfiguration/AndroidStudioConfiguration.md diff --git a/Documentation/CLionCodeStyleSettings.xml b/Documentation/EditorConfiguration/CLionCodeStyleSettings.xml similarity index 100% rename from Documentation/CLionCodeStyleSettings.xml rename to Documentation/EditorConfiguration/CLionCodeStyleSettings.xml diff --git a/Documentation/CLionConfiguration.md b/Documentation/EditorConfiguration/CLionConfiguration.md similarity index 97% rename from Documentation/CLionConfiguration.md rename to Documentation/EditorConfiguration/CLionConfiguration.md index 26627413331..14ae5a918ee 100644 --- a/Documentation/CLionConfiguration.md +++ b/Documentation/EditorConfiguration/CLionConfiguration.md @@ -41,7 +41,7 @@ It is possible to set the embedded terminal in CLion to the one that your WSL di This way you can build and run ladybird without leaving the IDE. Note that following will only help if you don't use an X-window server to access qemu. It is possible to install qemu natively on Windows and allow WSL to use it instead of installing qemu first on (wsl) linux and then use X server to launch ladybird inside of it. -Check the updated manual [here](BuildInstructionsWindows.md). +Check the updated manual [here](../BuildInstructionsLadybird.md#windows). - Locate the terminal emulator for your linux distribution. Open CMD with elevated privileges and cd to `C:/Program Files/WindowsApps/`. diff --git a/Documentation/EmacsConfiguration.md b/Documentation/EditorConfiguration/EmacsConfiguration.md similarity index 100% rename from Documentation/EmacsConfiguration.md rename to Documentation/EditorConfiguration/EmacsConfiguration.md diff --git a/Documentation/HelixConfiguration.md b/Documentation/EditorConfiguration/HelixConfiguration.md similarity index 100% rename from Documentation/HelixConfiguration.md rename to Documentation/EditorConfiguration/HelixConfiguration.md diff --git a/Documentation/NvimConfiguration.md b/Documentation/EditorConfiguration/NvimConfiguration.md similarity index 100% rename from Documentation/NvimConfiguration.md rename to Documentation/EditorConfiguration/NvimConfiguration.md diff --git a/Documentation/QtCreatorConfiguration.md b/Documentation/EditorConfiguration/QtCreatorConfiguration.md similarity index 93% rename from Documentation/QtCreatorConfiguration.md rename to Documentation/EditorConfiguration/QtCreatorConfiguration.md index c547c685e99..b042fe51625 100644 --- a/Documentation/QtCreatorConfiguration.md +++ b/Documentation/EditorConfiguration/QtCreatorConfiguration.md @@ -2,7 +2,7 @@ ## Setup -First, make sure you have a working toolchain and can build and run Ladybird. Go [here](BuildInstructionsLadybird.md) for instructions for setting that up. +First, make sure you have a working toolchain and can build and run Ladybird. Go [here](../BuildInstructionsLadybird.md) for instructions for setting that up. * Install [Qt Creator](https://www.qt.io/offline-installers). You don't need the entire Qt setup, just click 'Qt Creator' on the left side, and install that. * Open Qt Creator, select `File -> New File or Project...` @@ -38,7 +38,7 @@ Qt Creator should be set up correctly now, go ahead and explore the project and ## Auto-Formatting -You can use `clang-format` to help you with the [style guide](CodingStyle.md). Before you proceed, check that you're actually using clang-format version 18, as some OSes will ship other clang-format versions by default. +You can use `clang-format` to help you with the [style guide](../CodingStyle.md). Before you proceed, check that you're actually using clang-format version 18, as some OSes will ship other clang-format versions by default. - In QtCreator, go to "Help > About Plugins…" - Find the `Beautifier (experimental)` row (for example, by typing `beau` into the search) diff --git a/Documentation/VSCodeConfiguration.md b/Documentation/EditorConfiguration/VSCodeConfiguration.md similarity index 100% rename from Documentation/VSCodeConfiguration.md rename to Documentation/EditorConfiguration/VSCodeConfiguration.md diff --git a/Documentation/VimConfiguration.md b/Documentation/EditorConfiguration/VimConfiguration.md similarity index 100% rename from Documentation/VimConfiguration.md rename to Documentation/EditorConfiguration/VimConfiguration.md diff --git a/Documentation/README.md b/Documentation/README.md index 1457fb671c1..2e19d67da8c 100644 --- a/Documentation/README.md +++ b/Documentation/README.md @@ -12,13 +12,14 @@ you are welcome to ask on [Discord](../README.md#get-in-touch-and-participate). * [Profiling the Build](BuildProfilingInstructions.md) ## Configuring Editors -* [CLion](CLionConfiguration.md) -* [Emacs](EmacsConfiguration.md) -* [Helix](HelixConfiguration.md) -* [NVim](NvimConfiguration.md) -* [Qt Creator](QtCreatorConfiguration.md) -* [Vim](VimConfiguration.md) -* [VS Code](VSCodeConfiguration.md) +* [Android Studio](EditorConfiguration/AndroidStudioConfiguration.md) +* [CLion](EditorConfiguration/CLionConfiguration.md) +* [Emacs](EditorConfiguration/EmacsConfiguration.md) +* [Helix](EditorConfiguration/HelixConfiguration.md) +* [NVim](EditorConfiguration/NvimConfiguration.md) +* [Qt Creator](EditorConfiguration/QtCreatorConfiguration.md) +* [Vim](EditorConfiguration/VimConfiguration.md) +* [VS Code](EditorConfiguration/VSCodeConfiguration.md) ## Development * [How to Contribute](../CONTRIBUTING.md)