Pantyhose-X
/
LibreWeb-Browser
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readme

master
Melroy van den Berg 2022-02-09 00:13:30 +01:00
parent 92047d7d30
commit 30cb5f8de8
No known key found for this signature in database
GPG Key ID: 71D11FF23454B9D7
3 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -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

2
scripts/valgrind.sh
View File

@ -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

2
Windows.md → windows.md
View File

@ -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