From 4df2cdb50ba0402fc28e3a54b34b9f7d588c2a98 Mon Sep 17 00:00:00 2001 From: Bert van der Weerd Date: Sun, 7 Feb 2021 23:05:43 +0100 Subject: [PATCH] added documentation: HOW_TO_BUILD.md and TODO.md --- HOW_TO_BUILD.md | 31 +++++++++++++++++++ README.md | 81 ------------------------------------------------- TODO.md | 50 ++++++++++++++++++++++++++++++ 3 files changed, 81 insertions(+), 81 deletions(-) create mode 100644 HOW_TO_BUILD.md create mode 100644 TODO.md diff --git a/HOW_TO_BUILD.md b/HOW_TO_BUILD.md new file mode 100644 index 0000000..78d92b5 --- /dev/null +++ b/HOW_TO_BUILD.md @@ -0,0 +1,31 @@ + +Building the package: +--------------------- + +For now, if you want to attempt to build, this build does require you to: + +* First build the mozilla-unified as explained in the mozilla docs, using all the ./mach bootstrap stuff +* You can delete this mozilla-unified thing to save some space (try ./mach run on it just for fun) +* Then clone the windows repo: +``` +git clone --recursive https://gitlab.com/librewolf-community/browser/windows.git +``` +* cd into it, and build with: +``` +bash build.sh +``` +* You can perform each of the build steps individually and the overall script structure follows PKGBULD as used on Archlinux +* This will produce a **librewolf-85.0.en-US.win64.zip** in this windows folder. + +Once you have built the entire mozilla-unified with all the mach bootstrap stuff (which will +install the needed binaries in $HOME/.mozbuild), don't forget to copy the entire +C:\Program Files\Git folder to /c/mozilla-source to get a sed.exe that understands the -z option, +and to get sha256sum.exe. + +build.sh +-------- + +You can perform all the steps on one go, or perform the build steps individually, to note: +``` +bash build.sh fetch prepare build package installer_win +``` diff --git a/README.md b/README.md index a3b96e6..efdcb16 100644 --- a/README.md +++ b/README.md @@ -12,84 +12,3 @@ Download link to this prerelease is: Note: If your version of LibreWolf does _not_ run, an additional install of the [Microsoft Visual C++ 2010 Redistributable Package (x64)](https://www.microsoft.com/en-us/download/details.aspx?id=14632) might be required. Please consult the file **KNOWN_ISSUES.md** above, to see if your issue is already reported. - -Building the package: ---------------------- - -For now, if you want to attempt to build, this build does require you to: - -* First build the mozilla-unified as explained in the mozilla docs, using all the ./mach bootstrap stuff -* You can delete this mozilla-unified thing to save some space (try ./mach run on it just for fun) -* Then clone the windows repo: -``` -git clone --recursive https://gitlab.com/librewolf-community/browser/windows.git -``` -* cd into it, and build with: -``` -bash build.sh -``` -* You can perform each of the build steps individually and the overall script structure follows PKGBULD as used on Archlinux -* This will produce a **librewolf-85.0.en-US.win64.zip** in this windows folder. - -Once you have built the entire mozilla-unified with all the mach bootstrap stuff (which will -install the needed binaries in $HOME/.mozbuild), don't forget to copy the entire -C:\Program Files\Git folder to /c/mozilla-source to get a sed.exe that understands the -z option, -and to get sha256sum.exe. - -build.sh --------- - -You can perform all the steps on one go, or perform the build steps individually, to note: -``` -bash build.sh fetch prepare build package installer_win -``` - -To do: ------- - -* Listing known issues in this README.md -* Branding issues. -* Improve this README.md to contain better, detailed instructions on how to build. -* problem with old sed. does not recognize -z. using the one from Git might be a work around. - - -Branding issue(s): resource files ---------------------------------- - -* This section is just some notes. -* Build fail on missing stubinstaller (might be a FF bug as it should just take missing -stuff from the nightly branding folder?) - -``` -$ mkdir stubinstaller -$ cp bgstub.jpg stubinstaller -$ pwd -/c/mozilla-source/firefox-85.0/browser/branding/librewolf -$ - -* checking all the different files in nightly and librewolf - -$ cd nightly -$ find . | sort > /c/mozilla-source/branding-nightly.txt -$ cd ../librewolf/ -$ find . | sort > /c/mozilla-source/branding-librewolf.txt - - -$ diff branding-nightly.txt branding-librewolf.txt -4a5,6 -> ./bgstub.jpg -> ./bgstub_2x.jpg -7a10 -> ./content/about-background.png -9,10d11 -< ./content/about-logo.svg -< ./content/about-logo@2x.png -14,15d14 -< ./content/aboutlogins.svg -< ./content/firefox-wordmark.svg -22,24d20 -< ./default22.png -< ./default24.png -< ./default256.png -$ -``` diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..215d26e --- /dev/null +++ b/TODO.md @@ -0,0 +1,50 @@ +Things to do: +------------- + +These are ordered by priority: + +* Create an HOW_TO_BUILD.md to contain better, detailed instructions on how to build. +* Branding issues. We're going to need an MR with [LibreWolf / Browser / Common](https://gitlab.com/librewolf-community/browser/common) at some point. +* problem with old sed. does not recognize -z. using the one from Git might be a work around. + +Notes on the branding issue(s): +------------------------------- + +* This section is just some notes. +* Build fail on missing stubinstaller (might be a FF bug as it should just take missing +stuff from the nightly branding folder?) + +``` +$ mkdir stubinstaller +$ cp bgstub.jpg stubinstaller +$ pwd +/c/mozilla-source/firefox-85.0/browser/branding/librewolf +$ + +* checking all the different files in nightly and librewolf + +$ cd nightly +$ find . | sort > /c/mozilla-source/branding-nightly.txt +$ cd ../librewolf/ +$ find . | sort > /c/mozilla-source/branding-librewolf.txt + + +$ diff branding-nightly.txt branding-librewolf.txt +4a5,6 +> ./bgstub.jpg +> ./bgstub_2x.jpg +7a10 +> ./content/about-background.png +9,10d11 +< ./content/about-logo.svg +< ./content/about-logo@2x.png +14,15d14 +< ./content/aboutlogins.svg +< ./content/firefox-wordmark.svg +22,24d20 +< ./default22.png +< ./default24.png +< ./default256.png +$ +``` +