summaryrefslogtreecommitdiff
path: root/Documentation
AgeCommit message (Collapse)Author
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
2020-03-30Documentation: Inform people that `anon` can `su` to `root` by defaultAndreas Kling
\0 pointed out that this is not mentioned anywhere, technically making it a "local privilege escalation" bug. This patch adds it to the documentation, and I've also paid out the first $5 bounty to the "Kiwis for Kiwi" charity as per \0's request! http://serenityos.org/bounty/kiwis4kiwi.png
2020-03-28Documentation: Add build dependencies for FedoraLinus Groh
2020-03-20Documentation: Tweak document about smart pointers a bitAndreas Kling
Add notes about assigning between FooPtr / NonnullFooPtr.
2020-02-27Build: Use ccache if it's available (#1315)Alexander F. Rødseth
2020-02-01Documentation: Explain compilation of small changes and portsOliver Kraitschy
2020-01-23AK: Let's call decrementing reference counts "unref" instead of "deref"Andreas Kling
It always bothered me that we're using the overloaded "dereference" term for this. Let's call it "unreference" instead. :^)
2020-01-05Documentation: Suggest gcc-9 on Ubuntu since PPA doesn't have 8 anymoreElisée Maurer
2020-01-02Build: add support for building on OpenBSDjoshua stein
This requires gcc8 from ports to build the Toolchain.
2019-12-29Meta: Update ReadMe and move build instructions to a separate documentAndreas Kling
2019-11-06Meta: Move "Notes on WSL" to a separate file in Documentation/Andreas Kling
Since this is not relevant to the majority of people, let's move it out of the way.
2019-08-21Documentation: Let's have a coding style documentAndreas Kling
This is only meant to be about higher-level coding style, not the small things like brace placement, indentation, etc. For all of that we just obey clang-format.
2019-08-01Documentation: Add a paragraph about NonnullOwnPtr to SmartPointers.mdAndreas Kling
2019-06-21Documentation: Update SmartPointers.md with new pointer names.Andreas Kling
2019-05-28Documentation: RIP the short-lived coding styleRobin Burchell
Let's just use clang-format. It's easier than explaining the rules.
2019-05-28Documentation: Remove some irrelevant things from the coding style.Andreas Kling
This was adapted from the WebKit coding style docs, but some parts of it don't make sense for Serenity.
2019-05-28Documentation: Import an attempt at describing the project coding style.Andreas Kling
2019-05-15Documentation: Add a brief description of Serenity's smart pointer types.Andreas Kling