diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..daebd4c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# How to contribute: + +If you want to contribute, or just build from source yourself, below are the inistructions to do that. If there is something unclear please type your feedback in **[this ticket](https://gitlab.com/librewolf-community/browser/windows/-/issues/112)** and we can adress it. + +## Reference documentation: + +* [Building Firefox On Windows](https://firefox-source-docs.mozilla.org/setup/windows_build.html). + +## Compiling: + +To compile on Windows, you need to: + +* Install Mozilla build setup tools: [MozillaBuildSetup-Latest.exe](https://ftp.mozilla.org/pub/mozilla.org/mozilla/libraries/win32/MozillaBuildSetup-Latest.exe). +* Install Microsoft visual studio community edition: [here](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022). +* Within Visual Studio: +** Desktop development with C++. +** Windows 10 SDK (at least 10.0.19041.0). +** C++ ATL for v143 build tools (x86 and x64). + +* Open start-shell terminal and basically do the following: +``` +wget -q "https://hg.mozilla.org/mozilla-central/raw-file/default/python/mozboot/bin/bootstrap.py" +python3 bootstrap.py --no-interactive --application-choice=browser +``` +If you choose to, you can now build Firefox Nightly as follows: +``` +cd mozilla-unified +./mach build +./mach package +./mach run # or just run it.. +``` +Or you can just forget about that, and remove the firefox tree: +``` +rm -rf bootstrap.py mozilla-unified +``` +To build the current windows setup.exe, we do the following: +``` +git clone --recursive https://gitlab.com/librewolf-community/browser/windows.git +cd windows +./build.py all +``` diff --git a/README.md b/README.md index 7cf426e..8caf052 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,18 @@ # LibreWolf for windows * **[download latest release](https://gitlab.com/librewolf-community/browser/windows/-/releases)** -* or install via _[chocolatey](https://community.chocolatey.org/packages/librewolf)_: `choco install librewolf` +* Visit [the FAQ](https://librewolf.net/docs/faq/). +* Install via _[chocolatey](https://community.chocolatey.org/packages/librewolf)_: `choco install librewolf` +* or install via _winget_: `winget install librewolf` * **If your LibreWolf crashes on startup**, you probably miss the right [Visual C++ Runtime](https://support.microsoft.com/en-us/topic/the-latest-supported-visual-c-downloads-2647da03-1eea-4433-9aff-95f26a218cc0). You want the _Visual Studio 2015, 2017 and 2019_ version for **x64**, which would be **[this file](https://aka.ms/vs/16/release/vc_redist.x64.exe)**. -* The .zip files are _'portable zip files'_ that allows for a user profile in the extracted zip file folders. Everything self-contained. +* The .zip files are _'portable zip files'_ that allows for a user profile in the extracted zip file folders. It is _self-contained_. # Settings repository * For all librewolf.cfg issues, go here: [[settings repository](https://gitlab.com/librewolf-community/settings)] - _([issues](https://gitlab.com/librewolf-community/settings/-/issues))_ # Community links - * [[reddit](https://www.reddit.com/r/LibreWolf/)] - [r/LibreWolf](https://www.reddit.com/r/LibreWolf/) 😺 * [[gitter](https://gitter.im/librewolf-community/librewolf)], and the same room on [matrix](https://app.element.io/#/room/#librewolf-community_librewolf:gitter.im) (element.io). +* The install instructions for Windows on [librewolf.net](https://librewolf.net/installation/windows/). +* Want to compile it for yourself or contribute? check [CONTRIBUTING.md](https://gitlab.com/librewolf-community/browser/windows/-/blob/master/CONTRIBUTING.md).