From 3ba621782ccee969b2f66c2920225f3417186763 Mon Sep 17 00:00:00 2001 From: Alexander David Frick Date: Mon, 6 Jun 2022 16:31:38 -0700 Subject: [PATCH] Update README.md --- infra/DEBUG/README.md | 22 ++++++---------------- 1 file changed, 6 insertions(+), 16 deletions(-) diff --git a/infra/DEBUG/README.md b/infra/DEBUG/README.md index 1c2a92c2..5ae6e9c9 100644 --- a/infra/DEBUG/README.md +++ b/infra/DEBUG/README.md @@ -1,18 +1,8 @@ -## Thorium Debugging Infra - -  This contains .gn files, scripts, and other artifacts like vdpau-va-driver and flash player and the BUILDER file which contains notes (generally only usable by me, but feel free to ask what the info inside is for). \ -  The args.list file shows all possible build arguments, and the gn_args.list shows all possible build args after the Thorium args have been added, and the win_args.list shows all possible build arguments for Windows builds. \ -  The *.gn files contain what you should use in the args.gn for platforms other than the normal Linux release (which is in the root of this repo.) - - 69_release_args.gn is for Chromium 60-70 versions. - - android_args.gn is for Android ARM64. > https://chromium.googlesource.com/chromium/src/+/main/docs/android_build_instructions.md - - 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 - - mac_args.gn is for x64 macs. - - windows_args.gn is for Windows x64 \ - - The cgpt file is an optimized build of cgpt for Linux/ChromiumOS, you can put anywhere in your $PATH > https://chromium.googlesource.com/chromiumos/platform/vboot_reference/+/refs/heads/main/README - - The DEBUG dir is for DEBUGGING, see README.md inside it. - - – The WIN_INSTRUCTIONS.txt and WIN_CROSS_BUILD_INSTRUCTIONS.txt are for how to build Thorium for Windows natively and on Linux, respectively. - - – The thorium_devel_bookmarks.html file contain the bookmarks I use for Thorium development and rebasing the files it uses. +## Thorium Debugging Infra + - This contains .gn files and scripts for generating DEBUG builds of Thorium for debugging, testing, and inspection. + - The ABOUT_GN_ARGS.txt describes what each line in the args *.gn files do, also useful for the regular build args *.gn files. \ +    #NOTE: You cannot build installers for any platform with a debug build. Running the clean.sh script in the root of the repo is highly reccomended to get your //out/thorium dir from ~6-7 GB to something reasonable, like ~1-2 GB. + - Running the `build_debug.sh` or `build_win_debug.sh` will build the *Thorium UI Debug Shell (views_examples_with_content)* target as well as the rest of Thorium. + - Running `build_debug_shell.sh` can be used for any platform, and will build the standalone Thorium UI Debug Shell. (Read the DEBUG_SHELL_README.md file).