summaryrefslogtreecommitdiff
path: root/Documentation
AgeCommit message (Collapse)Author
2020-12-11Meta: Update bare metal installation guideDan MacDonald
2020-11-07Documentation: Update required GCC version to >= 10Linus Groh
I initially thought as long as Lagom is not built >= 9 would be fine, but LagomCore is always built for the code generators.
2020-10-18Documentation: Remove outdated comment about global git identityAndreas Kling
This was used by the toolchain build script at one point but is now only used when running BuildIt.sh with --dev.
2020-10-18Documentation: Remove "flock" from dependenciesAndreas Kling
The build system no longer uses "flock", so stop telling people they need to install it.
2020-10-12Toolchain: Upgrade to GCC 10.2.0Andreas Kling
2020-10-03Everywhere: Fix more typosLinus Groh
2020-10-02Meta: Update OpenSUSE build dependencies (#3655)zilrich
2020-09-26Documentation: Debian gcc-9 installation instructionsRobbe De Greef
We already have installation instructions for ubuntu but not yet for Debian. Gcc-9 is not available on Debian stable so instructions for switching to and from Debian testing are added.
2020-09-26Documentation: Serenity requires GCC 9 or higherRobbe De Greef
Gcc 8.3.0 (which is the current version in debian 10 stable) seems to fail at building AK. New people might get stuck when they try to run make inside the ./Build folder and fail at building serenity.
2020-09-07Documentation: Fixed minor typo in UsingQtCreatorJakob-Niklas See
2020-09-03Documentation: Add Windows section in build instructionsLuke
It seems that new people go to the build instructions from the main README, don't see Windows and are then stuck. We do have instructions for Windows, but they aren't noted in the build instructions, so new people get stuck thinking there's no way to build on Windows.
2020-08-25Documentation: Update BuildInstructions.mdSergio Ahumada
Add missing `cmake ..' line before compiling with make
2020-08-17Meta: Explain how to build with ninjaBen Wiederhake
Inspired by #3047, and my struggles to understand how cmake is supposed to work ^^ Thanks to @bgianfo, who made me realize that ninja can be used just like make. No idea why I didn't notice that earlier.
2020-08-17LibWeb: Rename WebContentView => OutOfProcessWebViewAndreas Kling
2020-08-15Meta: Document QtCreator auto-format and compiler kitsBen Wiederhake
2020-08-14Docs: explain how to enable QEMU hardware acceleration on WindowsPeter Nelson
Describes how to enable QEMU hardware acceleration on Windows using the Windows Hypervisor Platform feature.
2020-08-14Docs: clarify steps to use Windows-native QEMU when building under WSLPeter Nelson
This now descibes how to get the regular `make run` workflow to work under Windows using native QEMU. It describes how to override the QEMU binary path, as well as overriding the SerenityOS disk image file location with a native Windows path. Also fixes some minor spelling and punctuation issues.
2020-08-11Meta: Fix typo in NotesOnWSL.md (#3086)Andrew Mbugua
2020-08-07Documentation: Add a mention of the recent requirement for a newerValtteri Koskivuori
host compiler. On macOS this might have to be specified explicitly.
2020-08-06Documentation: Add a guide for setting up Qt CreatorValtteri Koskivuori
This was already in video form, but I figured it might be nice to have this here as well, to make it easier to discover.
2020-08-05Documentation: Add an installation guide for VirtualBoxLuke
Now that Serenity can run on VirtualBox, it's time for the documentation.
2020-07-26Documentation: Only install missing packages for Arch Linux.Paul Scharnofske
By default `pacman -S` will reinstall all the packages that are already installed on the system.
2020-07-15Meta: Add openSUSE dependencies to build documentation (#2801)Dominik M. Kwiatek
2020-07-06Documentation: Add note about DNS lookups to browser architecture docsAndreas Kling
2020-07-06Documentation: Add a document about the Browser process architectureAndreas Kling
2020-07-04Meta: Add ALT Linux packages to BuildInstructions.md (#2688)Petr Akhlamov
2020-06-28Documentation: Add filesystem note to WSL2 notesAndrew Kaster
WSL2 is now available in non-insider builds of Windows, starting with version 2004. Add a filesystem note regarding use of /mnt/c et al from WSL2 for compiling serenity. Namely, recommend against it as the performance across the 9p file system protocol is terrible for IO heavy jobs.
2020-06-21Meta: tweak build-image-grub.sh to allow running `make grub-image`..Emanuele Torre
without sudo.
2020-06-18Toolchain: Use curl instead of wget (#2574)Érico Nogueira Rolim
- For Linux: curl is already listed as a dependency; - For macOS: curl is pre-installed; - For OpenBSD and FreeBSD: curl is a dependecy of git.
2020-06-17Docs: Correct wording on CMake downloadsEwan
2020-06-17Docs: Spell CMake correctly in BuildInstructionsEwan
2020-06-16Docs: Add comment about required cmake versionEwan
Toolchain/BuiltIt.sh expected a version of cmake which apt did not provide for my system. Added note of the expected version and where to find a newer version.
2020-06-16Docs: Update FreeBSD instructions (#2510)Dominik Madarász
ginstall should not be symlinked to install globally. The actual issue of having GNU coreutils prefixed with `g` and not being picked up by CMake can be fixed on CMake level as noted here: https://github.com/SerenityOS/serenity/issues/2234#issuecomment-629754194
2020-05-28Meta: Move INSTALL.md into Documentation/Andreas Kling
2020-05-22Build: Add DockerfileYonatan Goldschmidt
2020-05-20Revert "Meta: Restore instructions to create build directory for CMake"Andreas Kling
This reverts commit 83137f76de2a406e1e58da0421240cb1f961cce5.
2020-05-20Meta: Restore instructions to create build directory for CMakeAndrew Kaster
We eliminated the need to pre-build LibC for libstdc++ by eliminating libstdc++ itself, so users need to create their own build directories again.
2020-05-17Meta: Update CLion and WSL configuration documentationsDevashish
This commit updates CLionConfiguration.md and NotesOnWSL.md so that they comply with new build system. In addition to that, the WSL doc is updated to include instructions to run qemu (and serenity) natively on Windows, without needing an X-window server.
2020-05-16Build: FreeBSD supportDominik Madarasz
2020-05-15Meta: Updated BuildInstructions.md for the cmake updateDexesTTP
List of changes: - The cmake command has been moved away from the main build instructions since the BuildIt script executes it automatically - The ninja install has been clarified to take the BuildIt script into account and explain that the folder needs to be cleaned before executing cmake - The ports instructions have been updated to use the make commands - "brew install bash" has been added to the macOS prerequisites as per #2132 - The build instructions headers have been indented to group the prerequisites together - The build instructions code snippets have been standardized into code blocks - Fixed a typo
2020-05-15Meta: Updated CodingStyle.md clang-format requirement from 8 to 10DexesTTP
Fixes #2213
2020-05-14Build: Switch to CMake :^)Sergey Bugaev
Closes https://github.com/SerenityOS/serenity/issues/2080
2020-05-08Services: Renamed from ServersAndreas Kling
It didn't feel right to have a "DHCPClient" in a "Servers" directory. Rename this to Services to better reflect the type of programs we'll be putting in there.
2020-05-07Build: Support building in DockerYonatan Goldschmidt
Add missing installations to instructions, and use genext2fs instead of mounting.
2020-05-06Documentation: Add note about /dev/kvm to BuildInstructions.mdAndreas Kling
2020-05-04Meta: Add configuration for setting up project in CLionDevashish
This commit adds a CMakeLists.txt file that will be used by CLion to configure the project and documentation explaining the steps to follow. Configuring CLion this way enables important features like code completion and file search. The configuration isn't perfect. There are source files for which CLion cannot pick up the headers and asks to manually include them from certain directories. But for the most part, it works all right.
2020-04-18Documentation: Add section about structs vs. classes to CodingStyle.mdAndreas Kling
2020-04-13Meta: Add Arch Linux (and derivatives) build instructionsAndres Vieira
This patch adds a one liner to install all the dependency packages needed to compile and run Serenity on Arch Linux, Manjaro, etc
2020-04-09Documentation: added additional info about moving to wsl2Ed Rochenski
2020-04-09Documentation: added note to prevent script failure in build sectionEd Rochenski