fix more docs
Author: Alexander Frick <Alex313031@gmail.com>
This commit is contained in:
CI
Alexander Frick
parent
0a1606dbba
commit
774de1eacc
|
|
@ -46,7 +46,7 @@
|
|||
> - GTK auto dark mode patch
|
||||
> - Various new flags either developed from scratch, or added from Ungoogled Chromium. See [PATCHES.md](https://github.com/Alex313031/thorium/blob/main/infra/PATCHES.md)
|
||||
> - Enable Parallel Downloading by Default.
|
||||
> - Inclusion of <img src="https://github.com/Alex313031/thorium/blob/main/logos/STAGING/pak.png" width="16"> [pak](https://github.com/Alex313031/thorium/tree/main/pak_src#readme) (Linux) and [pak_mingw](https://github.com/Alex313031/thorium/tree/main/pak_src/bin/pak-win) (Windows), a utility for packing and unpacking the [*.pak](https://textslashplain.com/2022/05/03/chromium-internals-pak-files/) files in Thorium or any other Chromium based browser.
|
||||
> - Inclusion of <img src="https://github.com/Alex313031/thorium/blob/main/logos/STAGING/pak.png" width="16"> [pak](https://github.com/Alex313031/thorium/tree/main/pak_src#readme) a utility for packing and unpacking the [*.pak](https://textslashplain.com/2022/05/03/chromium-internals-pak-files/) files in Thorium or any other Chromium based browser.
|
||||
> - Logo and Branding/Naming changed to the Thorium logo, Thorium name, and "Alex313031" being appended to "The Chromium Authors" in credits, etc.
|
||||
> - .desktop file includes useful cmdline flags that enable experimental or useful features. (See [PATCHES.md](https://github.com/Alex313031/thorium/blob/main/infra/PATCHES.md))
|
||||
> - Includes installer patches and files to include [ChromeDriver](https://chromedriver.chromium.org/home) and *thorium_shell* [(content_shell)](https://chromium.googlesource.com/chromium/src/+/HEAD/docs/testing/web_tests_in_content_shell.md), with a .desktop file being provided for thorium_shell (named thorium-shell.desktop and shows in desktop environments as Thorium Content Shell). These are also included in the Windows releases, but it doesn't make a shorcut, although a .png and .ico is in the install directory for you to make your own shortcut with an icon. You can also run content_shell with the command thorium-shell (custom wrapper for it, located in /usr/bin/). You can run ChromeDriver at /usr/bin/chromedriver or chromedriver.exe on Windows. Also, patches for abseil library and mini_installer when building with AVX on Windows.
|
||||
|
|
|
|||
|
|
@ -1,10 +1,11 @@
|
|||
## Thorium for ARM CPUs <img src="https://github.com/Alex313031/thorium/blob/main/logos/STAGING/arm_logo.png" width="128">
|
||||
This contains a special [*BUILD.gn*](https://github.com/Alex313031/thorium/blob/main/arm/config/compiler/BUILD.gn) file for making an ARM32/ARM64 build of Thorium for Raspberry Pi or Windows. Just run `setup_arm.sh` in here after running the normal `setup.sh` that's in the root of this repo.
|
||||
This contains a special [*BUILD.gn*](https://github.com/Alex313031/thorium/blob/main/arm/config/compiler/BUILD.gn) file for making an ARM64 build of Thorium for Raspberry Pi or Windows.
|
||||
Run `setup.sh --help` from the root of this repo for more information. You could use the `--raspi` flag for a Raspberry Pi build, or `--woa` for a Windows on ARM build.
|
||||
|
||||
__NOTE:__ This dir is only for Raspberry Pi and Windows On ARM. For regular Linux ARM builds, and MacOS ARM builds, you can just use the regular files in the repo.
|
||||
|
||||
- Windows On ARM (WoA) Builds: Use the [win_ARM_args.gn](https://github.com/Alex313031/thorium/blob/main/arm/win_ARM_args.gn) file for your *args.gn*.
|
||||
|
||||
## Raspberry Pi Builds <img src="https://github.com/Alex313031/thorium/blob/main/logos/STAGING/Raspberry_Pi_Logo.svg" width="28">
|
||||
__IMPORTANT:__ For a [Raspberry Pi](https://www.raspberrypi.org/) build (ARM64), the contents of [raspi_arm.gni](https://github.com/Alex313031/thorium/blob/main/arm/raspi_arm.gni) should be manually copied and used in *//chromium/src/build/config/arm.gni*, AND the contents of [raspi_args.gn](https://github.com/Alex313031/thorium/blob/main/arm/raspi_args.gn) should be used for your *args.gn*. \
|
||||
__– Note that ARM32 Raspberry Pi builds of Thorium are not supported.__ They should only be used on Raspi 3B, 3B+, 4, and 400 models with a 64 Bit OS. For more info, see > [Here](https://www.raspberrypi.com/news/raspberry-pi-os-64-bit/).
|
||||
Note that ARM32 Raspberry Pi builds of Thorium are not supported.__ They should only be used on Raspi 3B, 3B+, 4, and 400 models with a 64 Bit OS.
|
||||
For more info, see > [Here](https://www.raspberrypi.com/news/raspberry-pi-os-64-bit/).
|
||||
|
|
|
|||
|
|
@ -162,14 +162,12 @@ to enable Sync.
|
|||
|
||||
## Downloading the Thorium code
|
||||
|
||||
You can either use git clone, or download a .zip from the repo. It should be placed side by side with the Chromium directory in *C:\src*. \
|
||||
Using Git:
|
||||
It should be placed side by side with the Chromium directory in *C:\src*. \
|
||||
|
||||
```shell
|
||||
git clone --recursive https://github.com/Alex313031/thorium.git
|
||||
```
|
||||
Or download the .zip (Make sure to rename the extracted dir to just thorium, not thorium-main).
|
||||
[https://github.com/Alex313031/thorium/archive/refs/heads/main.zip](https://github.com/Alex313031/thorium/archive/refs/heads/main.zip)
|
||||
|
||||
## Setting up the build
|
||||
|
||||
|
|
|
|||
|
|
@ -60,9 +60,7 @@ And place it in ~/chromium/win
|
|||
|
||||
Now, lets download the Thorium tree, so run (in $HOME)
|
||||
|
||||
git clone --recursive https://github.com/Alex313031/thorium.git OR
|
||||
|
||||
Download the latest .zip > https://github.com/Alex313031/thorium/archive/refs/heads/main.zip
|
||||
git clone --recursive https://github.com/Alex313031/thorium.git
|
||||
|
||||
Then cd ~/Thorium, and we need to make some files executable. So run
|
||||
|
||||
|
|
|
|||
|
|
@ -71,7 +71,7 @@ Good, now we have a full Chromium checkout ready to be built, but to turn it int
|
|||
## Thorium Setup
|
||||
So, lets download Thorium in C:\src
|
||||
|
||||
git clone --recursive https://github.com/Alex313031/thorium.git or download the .zip and unpack it there > https://github.com/Alex313031/Thorium/archive/refs/heads/main.zip
|
||||
git clone --recursive https://github.com/Alex313031/thorium.git
|
||||
|
||||
Now, go back to C:\chromium\src
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
## Building <img src="https://github.com/Alex313031/thorium/blob/main/logos/NEW/build_light.svg#gh-dark-mode-only"> <img src="https://github.com/Alex313031/thorium/blob/main/logos/NEW/build_dark.svg#gh-light-mode-only">
|
||||
|
||||
_**The scripts assume the Chromium source is at $HOME/chromiums/src/ and Thorium is at $HOME/thorium/. You may have to 'sudo chmod +x' the scripts to make them executable.**_
|
||||
- __UPDATE:__ For Windows and Windows [AVX2](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions#Advanced_Vector_Extensions_2), I made new dedicated instructions. If you are building on Windows use > [WIN_INSTRUCTIONS.txt](https://github.com/Alex313031/thorium/blob/main/misc/WIN_INSTRUCTIONS.txt) and if you are building for Windows on Linux, use > [WIN_CROSS_BUILD_INSTRUCTIONS.txt](https://github.com/Alex313031/thorium/blob/main/misc/WIN_CROSS_BUILD_INSTRUCTIONS.txt)
|
||||
- __UPDATE:__ For Windows and Windows [AVX2](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions#Advanced_Vector_Extensions_2), I made new dedicated instructions. If you are building on Windows use > [WIN_INSTRUCTIONS.txt](https://github.com/Alex313031/thorium/blob/main/docs/WIN_INSTRUCTIONS.txt) and if you are building for Windows on Linux, use > [WIN_CROSS_BUILD_INSTRUCTIONS.txt](https://github.com/Alex313031/thorium/blob/main/docs/WIN_CROSS_BUILD_INSTRUCTIONS.txt)
|
||||
- In general we follow build instructions at https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/linux/build_instructions.md and API Keys (if desired) at https://www.chromium.org/developers/how-tos/api-keys <img src="https://github.com/Alex313031/thorium/blob/main/logos/NEW/Key_Light.svg#gh-dark-mode-only" width="28"> <img src="https://github.com/Alex313031/thorium/blob/main/logos/NEW/Key_Dark.svg#gh-light-mode-only" width="28">
|
||||
- Make sure dependencies are installed by running ./chromium/src/build/install-build-deps.sh.
|
||||
- After initial download of Chromium source code, run (from where you cloned this repo) `./trunk.sh`. This will update and sync the sources and at the end it will download the PGO profile for Chromium for all platforms. The file will be downloaded to *//chromium/src/chrome/build/pgo_profiles/*.profdata* with the actual file name looking something like 'chrome-linux-main-1632505958-ddbb37bcdfa7dbd7b10cf3a9b6a5bc45e7a958a6.profdata', which should be added to the end of args.gn as per below.
|
||||
|
|
|
|||
|
|
@ -5,15 +5,15 @@
|
|||
The *.gn files contain what you should use in the args.gn for platforms other than the normal Linux release (which is [here](https://github.com/Alex313031/thorium/blob/main/args.gn) in the root of this repo.)
|
||||
|
||||
- The [69_release_args.gn](https://github.com/Alex313031/thorium/blob/main/infra/69_release_args.gn) is for Chromium 60-70 versions.
|
||||
- The [android_args.gn](https://github.com/Alex313031/thorium/blob/main/infra/android_args.gn) is for Android ARM64. > https://chromium.googlesource.com/chromium/src/+/main/docs/android_build_instructions.md
|
||||
- The [cros_args.gn](https://github.com/Alex313031/thorium/blob/main/infra/cros_args.gn) is for ChromiumOS on Linux. > https://chromium.googlesource.com/chromium/src/+/main/docs/chromeos_build_instructions.md#Chromium-OS-on-Linux-linux_chromeos
|
||||
- The [mac_args.gn](https://github.com/Alex313031/thorium/blob/main/infra/mac_args.gn) is for x64 macs. (See [Thorium Special](https://github.com/Alex313031/Thorium-Special) for ARM64 M1 args.gn.)
|
||||
- The [win_args.gn](https://github.com/Alex313031/thorium/blob/main/infra/win_args.gn) is for Windows x64 \
|
||||
- The GN files [Here](https://github.com/Alex313031/thorium/blob/main/arm/android) are for Android (x86, x64, arm32, arm64). > https://chromium.googlesource.com/chromium/src/+/main/docs/android_build_instructions.md
|
||||
- The [cros_args.gn](https://github.com/Alex313031/thorium/blob/main/other/CrOS/cros_args.gn) is for ChromiumOS on Linux. > https://chromium.googlesource.com/chromium/src/+/main/docs/chromeos_build_instructions.md#Chromium-OS-on-Linux-linux_chromeos
|
||||
- The [mac_args.gn](https://github.com/Alex313031/thorium/blob/main/other/Mac/mac_args.gn) is for x64 MacOS. [mac_ARM_args.gn](https://github.com/Alex313031/thorium/blob/main/other/Mac/mac_ARM_args.gn) is for ARM64 M1/M2 MacOS.)
|
||||
- The [win_args.gn](https://github.com/Alex313031/thorium/blob/main/win_args.gn) is for Windows x64 \
|
||||
- The [cgpt](https://github.com/Alex313031/thorium/blob/main/infra/cgpt) file is a compiler optimized build of cgpt for Linux/ChromiumOS, you can put anywhere in your $PATH. See > https://chromium.googlesource.com/chromiumos/platform/vboot_reference/+/refs/heads/main/README
|
||||
- The DEBUG dir is for DEBUGGING, see the [README.md](https://github.com/Alex313031/thorium/tree/main/infra/DEBUG#readme) inside it.
|
||||
|
||||
– The [WIN_INSTRUCTIONS.txt](https://github.com/Alex313031/thorium/blob/main/infra/WIN_INSTRUCTIONS.txt) and [WIN_CROSS_BUILD_INSTRUCTIONS.txt](https://github.com/Alex313031/thorium/blob/main/infra/WIN_CROSS_BUILD_INSTRUCTIONS.txt) are for how to build Thorium for Windows natively and on Linux, respectively. \
|
||||
– See the [Docs](https://github.com/Alex313031/thorium/tree/main/docs#readme) dir for more instructions on building for a particular platform. \
|
||||
– The [DEV_CMDLINE_FLAGS.txt](https://github.com/Alex313031/thorium/blob/main/infra/DEV_CMDLINE_FLAGS.txt) has usefule command line flags for Debugging, Web Development, and Thorium development. The [CMDLINE_FLAGS_LIST.md](https://github.com/Alex313031/thorium/blob/main/infra/CMDLINE_FLAGS_LIST.md) contains a list of all possible cmdline flags for Chromium. It is borrowed from > https://peter.sh/experiments/chromium-command-line-switches/ \
|
||||
– The [thorium_devel_bookmarks.html](https://github.com/Alex313031/thorium/blob/main/infra/thorium_devel_bookmarks.html) file contain the bookmarks I use for Thorium development and rebasing the files it uses.
|
||||
– The [THORIUM_DEV_BOOKMARKS.html](https://github.com/Alex313031/thorium/blob/main/infra/THORIUM_DEV_BOOKMARKS.html) file contain the bookmarks I use for Thorium development and rebasing the files it uses.
|
||||
|
||||
<img src="https://github.com/Alex313031/thorium/blob/main/logos/NEW/thorium_infra_256.png" width="200">
|
||||
|
|
|
|||
|
|
@ -10,6 +10,6 @@ __IMPORTANT:__ The 'NEW' directory is where the new logos that are used since M1
|
|||
- The 'STAGING' dir is for test icons, scratch space, uploading temporary things, icons that don't fit anywhere else, etc.
|
||||
- This project also for a small time was called "[Technetium](https://github.com/Alex313031/Technetium)", and I experimented with different logo designs; some are lost, but one of them is in the 'OLD' directory. These extra things are in the 'OLD' directory along with the Thorium logos used since the beginning up until M100.
|
||||
|
||||
*LICENSING*: The Chromium Logo is licensed under Chromium's BSD-Style [License](https://github.com/Alex313031/thorium/blob/main/infra/CHROMIUM_LICENSE.txt), and some logos like the "bulb" and "build" logos are under Apache's License, which can be found here. The Thorium Logo is licensed under the GPL-3.0 License, however if you are going to use the logo in a derivative project, I would prefer if you let me know first.
|
||||
*LICENSING*: The Chromium Logo is licensed under Chromium's BSD-Style [License](https://github.com/Alex313031/thorium/blob/main/infra/CHROMIUM_LICENSE), and some logos like the "bulb" and "build" logos are under Apache's License, which can be found here. The Thorium Logo is licensed under the GPL-3.0 License, however if you are going to use the logo in a derivative project, I would prefer if you let me know first.
|
||||
|
||||
<img src="https://github.com/Alex313031/thorium/blob/main/logos/STAGING/error_dog.png" width="256">
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@
|
|||
<br/>
|
||||
ThoriumOS aims to produce a ChromiumOS image similar to <a title="Cloudready Archived WebSite" rel="noopener" target="_blank" href="https://web.archive.org/web/20220101085621/https://www.neverware.com/">CloudReady</a> (now <a title="ChromeOS Flex" rel="noopener" target="_blank" href="https://chromeenterprise.google/os/chromeosflex/">ChromeOS Flex</a>), with extra stuff including:
|
||||
<ul class="info">
|
||||
<br/>‣ Kernel configuration and <a title="About Linux Firmware" rel="noopener" target="_blank" href="https://wiki.gentoo.org/wiki/Linux_firmware">Linux firmware</a> to support as many devices as possible, <a title="ThoriumOS ReadMe" rel="noopener" target="_blank" href="https://github.com/Alex313031/thoriumOS#chromiumos-fork-with-thorium-browser-x264x265-codecs-widevine-kernel-515-linux-firmwaremodules-support-nouveau-intelamd-microcode-and-extra-packages">extra packages</a> for useful command line features, and some useful bash aliases.
|
||||
<br/>‣ Kernel configuration and <a title="About Linux Firmware" rel="noopener" target="_blank" href="https://wiki.gentoo.org/wiki/Linux_firmware">Linux firmware</a> to support as many devices as possible, <a title="ThoriumOS ReadMe" rel="noopener" target="_blank" href="https://github.com/Alex313031/ThoriumOS#chromiumos-fork-with-thorium-browser-x264x265-codecs-widevine-kernel-515-linux-firmwaremodules-support-nouveau-intelamd-microcode-and-extra-packages">extra packages</a> for useful command line features, and some useful bash aliases.
|
||||
<br/>‣ <a title="Widevine.org" rel="noopener" target="_blank" href="https://www.widevine.com/">Widevine</a> (needed for Netflix, etc.), <a title="About Google Sync" rel="noopener" target="_blank" href="https://support.google.com/chrome/answer/185277">Google Sync</a>, and <a title="Google Drive" rel="noopener" target="_blank" href="https://www.google.com/drive/">Google DriveFS</a></s> integration, which are normally excluded from ChromiumOS images.
|
||||
<br/>‣ And of course, <a title="Thorium Browser" rel="noopener" target="_blank" href="https://thorium.rocks/">Thorium browser</a>, with the <a title="Compiler Optimizations" rel="noopener" target="_blank" href="https://thorium.rocks/optimizations">compiler optimizations</a> of Thorium applied to the whole OS!
|
||||
</ul>
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
Subproject commit c3c915fb0dab3e1e766af4aebf8461592bbcef88
|
||||
Subproject commit c7ec859c82f12f5501ba34e0602e0d94bd6d61be
|
||||
Loading…
Reference in New Issue