From 30cb5f8de89c7949f8e47e298433512aee8336ea Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Wed, 9 Feb 2022 00:13:30 +0100 Subject: [PATCH] Update readme --- README.md | 17 ++++++++--------- scripts/valgrind.sh | 2 +- Windows.md => windows.md | 2 +- 3 files changed, 10 insertions(+), 11 deletions(-) rename Windows.md => windows.md (95%) diff --git a/README.md b/README.md index 3e4f673..0fe2094 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ The current success criteria: --- -The sections below are mainly relevant for software developers, who want to contribute or help LibreWeb Browser. +The sections below are mainly relevant for software developers, who want to contribute or help the LibreWeb Browser project. --- @@ -74,19 +74,18 @@ Personally, I'm using VSCodium editor, with the following extensions installed: For the **GNU/Linux build** you need at least: -* GCC 9 or higher (`build-essential`, `g++-9`) +* GCC 9 or higher (Packages: `build-essential g++-9`) * CMake (Package: `cmake`) * Ninja build system (Package: `ninja-build`) * Libcurl (Package: `libcurl4-openssl-dev`) -* GTK3 (including C++ bindings: gtkmm3): - * Package: `libgtkmm-3.0-dev` under Debian based distros +* GTK3/Gtkmm3 (Package: `libgtkmm-3.0-dev`) **Dependencies for testing:** * X virtual framebuffer (Package: `xvfb`) * Clang-format (Package: `clang-format`) -*Note:* For cross-compiling towards Windows and building on macOS see "Other platforms" section below. +*Note:* For cross-compiling towards Windows and building on macOS see "[Other platforms](#Other%20platforms)" section below. ### Linux Build @@ -124,7 +123,7 @@ Or just use script: ### C++ Coding Style Guidelines -#### Automated Clang-format +#### Automated Clang Format We use our [own Clang LLVM C++ Programming Style Format](.clang-format), using [clang-format](https://clang.llvm.org/docs/ClangFormat.html) command. @@ -138,7 +137,7 @@ Check only for errors, run: `./scripts/check-format.sh` #### Core Guidelines -We also tend to follow the [C++ Core Guidelines](http://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines) as much as possible. +We also tend to follow the popular [C++ Core Guidelines](http://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines) as much as possible. ### Doxygen @@ -148,7 +147,7 @@ Doxygen is build by default. You can disable the doxygen build, if you want, usi ### Memory Leaks -First **build** the (GNU/Linux) target with *debug symbols*. Build target file should be present: `./build/bin/libreweb-browser`. +First **build** the (Linux) target including *debug symbols*. Binary should be present in the `build/src` folder. Next, check for memory leaks using `valgrind` by executing: @@ -205,7 +204,7 @@ Build a production release + packaging with [NSIS](https://sourceforge.net/proje ./scripts/build-win-prod.sh ``` -See also: [Windows readme](Windows.md) file. +See also: [Windows ReadMe](windows.md) file. ### Apple MacOS / Darwin diff --git a/scripts/valgrind.sh b/scripts/valgrind.sh index 1971acc..bbe2a97 100755 --- a/scripts/valgrind.sh +++ b/scripts/valgrind.sh @@ -3,4 +3,4 @@ # Description: Used for memory leak analysis, # be-aware that you will get a lot of false positives messages due to GTK -valgrind --leak-check=full --track-origins=yes ./libreweb-browser +valgrind --leak-check=full --track-origins=yes ./build/src/libreweb-browser diff --git a/Windows.md b/windows.md similarity index 95% rename from Windows.md rename to windows.md index 768c929..74569c0 100644 --- a/Windows.md +++ b/windows.md @@ -1,6 +1,6 @@ # Windows Packaging -The additional files in `packaging_win` are required for packaging to the Windows platform. +The additional files in `packaging_win` are required for packaging to the Windows platform (after the cross-compile went successfully). ## GTK Windows 10 Theme