mirror of
https://github.com/LadybirdBrowser/ladybird.git
synced 2024-11-21 23:20:20 +00:00
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.
This commit is contained in:
parent
c036e87d46
commit
25441e2250
Notes:
github-actions[bot]
2024-10-23 07:03:49 +00:00
Author: https://github.com/AtkinsSJ Commit: https://github.com/LadybirdBrowser/ladybird/commit/25441e22504 Pull-request: https://github.com/LadybirdBrowser/ladybird/pull/1914 Reviewed-by: https://github.com/ADKaster
11 changed files with 12 additions and 11 deletions
|
@ -176,7 +176,7 @@ pkgman install cmake cmd:python3 ninja openal_devel qt6_base_devel qt6_multimedi
|
||||||
|
|
||||||
### Android:
|
### 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``
|
Or, download a version of Gradle >= 8.0.0, and run the ``gradlew`` program in ``Ladybird/Android``
|
||||||
|
|
||||||
## Build steps
|
## Build steps
|
||||||
|
|
|
@ -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.
|
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.
|
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.
|
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.
|
- Locate the terminal emulator for your linux distribution.
|
||||||
Open CMD with elevated privileges and cd to `C:/Program Files/WindowsApps/`.
|
Open CMD with elevated privileges and cd to `C:/Program Files/WindowsApps/`.
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
## Setup
|
## 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.
|
* 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...`
|
* 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
|
## 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…"
|
- In QtCreator, go to "Help > About Plugins…"
|
||||||
- Find the `Beautifier (experimental)` row (for example, by typing `beau` into the search)
|
- Find the `Beautifier (experimental)` row (for example, by typing `beau` into the search)
|
|
@ -12,13 +12,14 @@ you are welcome to ask on [Discord](../README.md#get-in-touch-and-participate).
|
||||||
* [Profiling the Build](BuildProfilingInstructions.md)
|
* [Profiling the Build](BuildProfilingInstructions.md)
|
||||||
|
|
||||||
## Configuring Editors
|
## Configuring Editors
|
||||||
* [CLion](CLionConfiguration.md)
|
* [Android Studio](EditorConfiguration/AndroidStudioConfiguration.md)
|
||||||
* [Emacs](EmacsConfiguration.md)
|
* [CLion](EditorConfiguration/CLionConfiguration.md)
|
||||||
* [Helix](HelixConfiguration.md)
|
* [Emacs](EditorConfiguration/EmacsConfiguration.md)
|
||||||
* [NVim](NvimConfiguration.md)
|
* [Helix](EditorConfiguration/HelixConfiguration.md)
|
||||||
* [Qt Creator](QtCreatorConfiguration.md)
|
* [NVim](EditorConfiguration/NvimConfiguration.md)
|
||||||
* [Vim](VimConfiguration.md)
|
* [Qt Creator](EditorConfiguration/QtCreatorConfiguration.md)
|
||||||
* [VS Code](VSCodeConfiguration.md)
|
* [Vim](EditorConfiguration/VimConfiguration.md)
|
||||||
|
* [VS Code](EditorConfiguration/VSCodeConfiguration.md)
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
* [How to Contribute](../CONTRIBUTING.md)
|
* [How to Contribute](../CONTRIBUTING.md)
|
||||||
|
|
Loading…
Reference in a new issue