Andrew Mbugua
1f7190d3bd
Meta: Fix typo in NotesOnWSL.md ( #3086 )
2020-08-11 14:27:00 +02:00
Valtteri Koskivuori
c1f633e1ee
Documentation: Add a mention of the recent requirement for a newer
...
host compiler. On macOS this might have to be specified explicitly.
2020-08-07 09:07:10 +02:00
Valtteri Koskivuori
b4a29113e4
Documentation: Add a guide for setting up Qt Creator
...
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-06 10:22:14 +02:00
Luke
f71b112530
Documentation: Add an installation guide for VirtualBox
...
Now that Serenity can run on VirtualBox, it's time for the documentation.
2020-08-05 10:52:48 +02:00
Paul Scharnofske
fbc54a2dba
Documentation: Only install missing packages for Arch Linux.
...
By default `pacman -S` will reinstall all the packages that are already installed on the system.
2020-07-26 17:48:24 +02:00
Dominik M. Kwiatek
782cd93c01
Meta: Add openSUSE dependencies to build documentation ( #2801 )
2020-07-15 00:06:16 +02:00
Andreas Kling
1037a24076
Documentation: Add note about DNS lookups to browser architecture docs
2020-07-06 18:41:41 +02:00
Andreas Kling
d897940e02
Documentation: Add a document about the Browser process architecture
2020-07-06 16:17:43 +02:00
Petr Akhlamov
188c83328f
Meta: Add ALT Linux packages to BuildInstructions.md ( #2688 )
2020-07-04 10:51:16 +02:00
Andrew Kaster
4f71bd54a7
Documentation: Add filesystem note to WSL2 notes
...
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-28 00:06:27 +02:00
Emanuele Torre
e42f4abd61
Meta: tweak build-image-grub.sh to allow running make grub-image
..
...
without sudo.
2020-06-21 10:13:04 +02:00
Érico Nogueira Rolim
fef9ad520b
Toolchain: Use curl instead of wget ( #2574 )
...
- 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-18 16:31:12 +02:00
Ewan
0609a85166
Docs: Correct wording on CMake downloads
2020-06-17 15:08:47 +02:00
Ewan
92eed96265
Docs: Spell CMake correctly in BuildInstructions
2020-06-17 15:08:47 +02:00
Ewan
6a567e1191
Docs: Add comment about required cmake version
...
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-16 13:54:47 +02:00
Dominik Madarász
7e2cf4be4b
Docs: Update FreeBSD instructions ( #2510 )
...
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-06-16 13:31:11 +02:00
Andreas Kling
68177fd9a1
Meta: Move INSTALL.md into Documentation/
2020-05-28 13:09:43 +02:00
Yonatan Goldschmidt
00c0650f96
Build: Add Dockerfile
2020-05-22 01:19:15 +02:00
Andreas Kling
59c3b3b702
Revert "Meta: Restore instructions to create build directory for CMake"
...
This reverts commit 83137f76de
.
2020-05-20 16:24:26 +02:00
Andrew Kaster
83137f76de
Meta: Restore instructions to create build directory for CMake
...
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-20 08:37:50 +02:00
Devashish
e4f7080bbd
Meta: Update CLion and WSL configuration documentations
...
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-17 23:07:35 +02:00
Dominik Madarasz
4e27c58be7
Build: FreeBSD support
2020-05-16 11:01:14 +02:00
DexesTTP
5386508119
Meta: Updated BuildInstructions.md for the cmake update
...
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-15 09:48:14 +02:00
DexesTTP
c715b13ffc
Meta: Updated CodingStyle.md clang-format requirement from 8 to 10
...
Fixes #2213
2020-05-15 09:48:14 +02:00
Sergey Bugaev
450a2a0f9c
Build: Switch to CMake :^)
...
Closes https://github.com/SerenityOS/serenity/issues/2080
2020-05-14 20:15:18 +02:00
Andreas Kling
cf3b58fbe8
Services: Renamed from Servers
...
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-08 21:57:44 +02:00
Yonatan Goldschmidt
3df3ab4598
Build: Support building in Docker
...
Add missing installations to instructions, and use genext2fs instead
of mounting.
2020-05-07 10:23:26 +02:00
Andreas Kling
eabb7b563a
Documentation: Add note about /dev/kvm to BuildInstructions.md
2020-05-06 17:12:49 +02:00
Devashish
f22c973ba3
Meta: Add configuration for setting up project in CLion
...
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-05-04 09:50:45 +02:00
Andreas Kling
2b7fc08db3
Documentation: Add section about structs vs. classes to CodingStyle.md
2020-04-18 11:14:05 +02:00
Andres Vieira
e9c65b6566
Meta: Add Arch Linux (and derivatives) build instructions
...
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-13 17:38:27 +02:00
Ed Rochenski
551cafe4d3
Documentation: added additional info about moving to wsl2
2020-04-09 11:35:43 +02:00
Ed Rochenski
932de565b1
Documentation: added note to prevent script failure in build section
2020-04-09 11:35:43 +02:00
Andreas Kling
ec91d2eb9f
Documentation: Inform people that anon
can su
to root
by default
...
\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-30 11:35:39 +02:00
Linus Groh
c5cf740830
Documentation: Add build dependencies for Fedora
2020-03-28 22:12:20 +01:00
Andreas Kling
2176a3dd18
Documentation: Tweak document about smart pointers a bit
...
Add notes about assigning between FooPtr / NonnullFooPtr.
2020-03-20 14:41:02 +01:00
Alexander F. Rødseth
cdb58cdfd2
Build: Use ccache if it's available ( #1315 )
2020-02-27 11:44:29 +01:00
Oliver Kraitschy
aab59eaaab
Documentation: Explain compilation of small changes and ports
2020-02-01 20:16:24 +01:00
Andreas Kling
3de5439579
AK: Let's call decrementing reference counts "unref" instead of "deref"
...
It always bothered me that we're using the overloaded "dereference"
term for this. Let's call it "unreference" instead. :^)
2020-01-23 15:14:21 +01:00
Elisée Maurer
9e22b83343
Documentation: Suggest gcc-9 on Ubuntu since PPA doesn't have 8 anymore
2020-01-05 08:57:43 +01:00
joshua stein
5e430e4eb4
Build: add support for building on OpenBSD
...
This requires gcc8 from ports to build the Toolchain.
2020-01-02 21:03:53 +01:00
Andreas Kling
fd14795f9d
Meta: Update ReadMe and move build instructions to a separate document
2019-12-29 16:23:50 +01:00
Andreas Kling
1133acabb2
Meta: Move "Notes on WSL" to a separate file in Documentation/
...
Since this is not relevant to the majority of people, let's move it
out of the way.
2019-11-06 21:03:18 +01:00
Andreas Kling
af840af1ce
Documentation: Let's have a coding style document
...
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-21 17:01:29 +02:00
Andreas Kling
f4bae8971c
Documentation: Add a paragraph about NonnullOwnPtr to SmartPointers.md
2019-08-01 14:35:50 +02:00
Andreas Kling
e97d714bbc
Documentation: Update SmartPointers.md with new pointer names.
2019-06-21 18:42:17 +02:00
Robin Burchell
faafaf9b43
Documentation: RIP the short-lived coding style
...
Let's just use clang-format. It's easier than explaining the rules.
2019-05-28 17:31:20 +02:00
Andreas Kling
854598bc46
Documentation: Remove some irrelevant things from the coding style.
...
This was adapted from the WebKit coding style docs, but some parts of it
don't make sense for Serenity.
2019-05-28 11:43:28 +02:00
Andreas Kling
fc3732759d
Documentation: Import an attempt at describing the project coding style.
2019-05-28 11:40:44 +02:00
Andreas Kling
3cd1db09d4
Documentation: Add a brief description of Serenity's smart pointer types.
2019-05-15 14:07:14 +02:00