├── Images ├── .placeholder ├── brunch-config-menu │ ├── .placeholder │ ├── cmd-line-params.png │ ├── custom-params.png │ ├── edit-brunch-config.png │ ├── framework-options-1.png │ ├── framework-options-2.png │ ├── select-bootsplash.png │ ├── select-kernel.png │ ├── summary.png │ └── verbose-mode.png ├── decon_icon-24.png ├── decon_icon-512.png ├── settings_icon-512.png ├── terminal_icon-24.png └── terminal_icon-512.png ├── LICENSE ├── README.md ├── Readme ├── Building.md ├── install-with-linux.md ├── install-with-windows.md └── troubleshooting-and-faqs.md └── brunch.der /Images/.placeholder: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /Images/brunch-config-menu/.placeholder: -------------------------------------------------------------------------------- 1 | Screenshots of the Brunch Configuration Menu 2 | -------------------------------------------------------------------------------- /Images/brunch-config-menu/cmd-line-params.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sebanc/brunch/0a6da64458c50cc9ffb8932556e36bbdf9616a44/Images/brunch-config-menu/cmd-line-params.png -------------------------------------------------------------------------------- /Images/brunch-config-menu/custom-params.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sebanc/brunch/0a6da64458c50cc9ffb8932556e36bbdf9616a44/Images/brunch-config-menu/custom-params.png -------------------------------------------------------------------------------- /Images/brunch-config-menu/edit-brunch-config.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sebanc/brunch/0a6da64458c50cc9ffb8932556e36bbdf9616a44/Images/brunch-config-menu/edit-brunch-config.png -------------------------------------------------------------------------------- /Images/brunch-config-menu/framework-options-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sebanc/brunch/0a6da64458c50cc9ffb8932556e36bbdf9616a44/Images/brunch-config-menu/framework-options-1.png -------------------------------------------------------------------------------- /Images/brunch-config-menu/framework-options-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sebanc/brunch/0a6da64458c50cc9ffb8932556e36bbdf9616a44/Images/brunch-config-menu/framework-options-2.png -------------------------------------------------------------------------------- /Images/brunch-config-menu/select-bootsplash.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sebanc/brunch/0a6da64458c50cc9ffb8932556e36bbdf9616a44/Images/brunch-config-menu/select-bootsplash.png -------------------------------------------------------------------------------- /Images/brunch-config-menu/select-kernel.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sebanc/brunch/0a6da64458c50cc9ffb8932556e36bbdf9616a44/Images/brunch-config-menu/select-kernel.png -------------------------------------------------------------------------------- /Images/brunch-config-menu/summary.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sebanc/brunch/0a6da64458c50cc9ffb8932556e36bbdf9616a44/Images/brunch-config-menu/summary.png -------------------------------------------------------------------------------- /Images/brunch-config-menu/verbose-mode.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sebanc/brunch/0a6da64458c50cc9ffb8932556e36bbdf9616a44/Images/brunch-config-menu/verbose-mode.png -------------------------------------------------------------------------------- /Images/decon_icon-24.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sebanc/brunch/0a6da64458c50cc9ffb8932556e36bbdf9616a44/Images/decon_icon-24.png -------------------------------------------------------------------------------- /Images/decon_icon-512.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sebanc/brunch/0a6da64458c50cc9ffb8932556e36bbdf9616a44/Images/decon_icon-512.png -------------------------------------------------------------------------------- /Images/settings_icon-512.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sebanc/brunch/0a6da64458c50cc9ffb8932556e36bbdf9616a44/Images/settings_icon-512.png -------------------------------------------------------------------------------- /Images/terminal_icon-24.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sebanc/brunch/0a6da64458c50cc9ffb8932556e36bbdf9616a44/Images/terminal_icon-24.png -------------------------------------------------------------------------------- /Images/terminal_icon-512.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sebanc/brunch/0a6da64458c50cc9ffb8932556e36bbdf9616a44/Images/terminal_icon-512.png -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 | 3 | 4 | [![License][license-shield]][license-url] 5 | [![Issues][issues-shield]][issues-url] 6 | [![Discord][discord-shield]][discord-url] 7 | 8 | 9 |

10 | 11 | Logo 12 | 13 |

14 |

Brunch Framework

15 | 16 | 17 | 18 | ## Special Thanks 19 | 20 | First of all, thanks goes to [Project Croissant][croissant], the [swtpm][swtpm] maintainer, the [Linux-Surface crew][linux-surface] and the [Chromebrew framework][chromebrew] for their work which was actively used when creating this project. 21 | 22 | 23 | ## About This Project 24 | 25 | The purpose of the Brunch framework is to create a generic x86_64 ChromeOS image from an official recovery image. To do so, it uses a 1GB ROOTC partition (containing a custom kernel, an initramfs, the swtpm binaries, userspace patches and config files) and a specific EFI partition to boot from it. 26 | 27 | **Warning: Brunch is not the intended way for ChromeOS to work, at some point ChromeOS could potentially become incompatible with Brunch and delete data unexpectedly (even on non-ChromeOS partitions). By installing Brunch you agree to take those risks and I cannot be held responsible for anything bad that would happen to your device including data loss. 28 | It is therefore highly recommended to only use this framework on a device which does not contain any sensitive data and to keep data synced with a cloud service.** 29 | 30 | 31 | ## Supported Hardware 32 | 33 | Hardware support is highly dependent on the general Linux kernel hardware compatibility. As such only Linux supported hardware will work and the same specific kernel command line options recommended for your device should be passed through the Grub bootloader (see "Modify the Grub bootloader" section). Some features such as camera, microphone and touchpad may not work or may require troubleshooting to get working. 34 | 35 | 36 | ✔ Base Requirements: 37 | - x86_64 based computer with UEFI boot support. 38 | - Administrative privileges on the device. 39 | - An entry level understanding of the linux terminal. 40 | - This guide aims to make this process as easy as possible, but knowing the basics is expected. 41 | 42 | 43 | ✔ CPU Compatibility: 44 | - [Intel CPUs][intel-cpus] from 8th Gen / [Celeron CPUs][celeron-cpus] from Goldmont 45 | - [AMD Ryzen][amd-ry-list] 46 | 47 | 48 | ❌ Unsupported Hardware: 49 | - Older Intel/AMD CPUs are not supported. 50 | - dGPUs are not supported. 51 | - Virtual Machines are not supported. 52 | - ARM CPUs are not supported. 53 | 54 | 55 | ## Install Instructions 56 | This guide has been split into seperate sections, please follow one of the links below for a guide suitable to your current operating system. 57 | 58 | ### New: Simplified install with [linuxloops][linuxloops] 59 | 60 | Linuxloops is a tool that allows the installation of Brunch with a GUI. 61 | 62 | First, identify the recovery image suitable for your CPU: 63 | #### Intel 64 | * 8th gen & 9th gen: "[shyvana][recovery-shyvana]" for Intel / "[bobba][recovery-bobba]" for Celeron. 65 | * 10th gen: "[jinlon][recovery-jinlon]". 66 | * 11th gen & above: "[voxel][recovery-voxel]". 67 | #### AMD 68 | * Ryzen: "[gumboz][recovery-gumboz]". 69 | 70 | Once you have identified the recovery image suitable for your CPU, follow the instructions in the [linuxloops][linuxloops] repository Readme. 71 | 72 | ### Manual install instructions 73 | 74 | ### [![Install with Linux][linux-img]][linux-guide] [Install with Linux][linux-guide] 75 | ### [![Install with Windows][windows-img]][windows-guide] [Install with Windows][windows-guide] 76 | 77 | ## Troubleshooting and Support 78 | 79 | In case you run into issues while installing or using Brunch, you can find support on Discord: 80 | 81 | [![Discord][discord-shield]][discord-url] 82 | 83 | Additional troubleshooting and support tips can be found at the following page: 84 | 85 | ### [![Troubleshooting][decon-icon-24]][troubleshooting-and-faqs] [Troubleshooting and Support][troubleshooting-and-faqs] 86 | 87 | 88 | 89 | 90 | 91 | [license-shield]: https://img.shields.io/github/license/sebanc/brunch?label=License&logo=Github&style=flat-square 92 | [license-url]: ./LICENSE 93 | [forks-shield]: https://img.shields.io/github/forks/sebanc/brunch?label=Forks&logo=Github&style=flat-square 94 | [forks-url]: https://github.com/sebanc/brunch/fork 95 | [stars-shield]: https://img.shields.io/github/stars/sebanc/brunch?label=Stars&logo=Github&style=flat-square 96 | [stars-url]: https://github.com/sebanc/brunch/stargazers 97 | [issues-shield]: https://img.shields.io/github/issues/sebanc/brunch?label=Issues&logo=Github&style=flat-square 98 | [issues-url]: https://github.com/sebanc/brunch/issues 99 | [pulls-shield]: https://img.shields.io/github/issues-pr/sebanc/brunch?label=Pull%20Requests&logo=Github&style=flat-square 100 | [pulls-url]: https://github.com/sebanc/brunch/pulls 101 | [discord-shield]: https://img.shields.io/badge/Discord-Join-7289da?style=flat-square&logo=discord&logoColor=%23FFFFFF 102 | [discord-url]: https://discord.gg/x2EgK2M 103 | 104 | 105 | [linuxloops]: https://github.com/sebanc/linuxloops 106 | [croissant]: https://github.com/imperador/chromefy 107 | [swtpm]: https://github.com/stefanberger/swtpm 108 | [linux-surface]: https://github.com/linux-surface/linux-surface 109 | [chromebrew]: https://github.com/skycocker/chromebrew 110 | [celeron-cpus]: https://en.wikipedia.org/wiki/List_of_Intel_Celeron_processors 111 | [intel-cpus]: https://en.wikipedia.org/wiki/Intel_Core 112 | [intel-list]: https://en.wikipedia.org/wiki/List_of_Intel_CPU_microarchitectures 113 | [atom-cpus]: https://en.wikipedia.org/wiki/Intel_Atom 114 | [atom-list]: https://en.wikipedia.org/wiki/List_of_Intel_Atom_microprocessors 115 | [amd-sr-list]: https://en.wikipedia.org/wiki/List_of_AMD_accelerated_processing_units#%22Stoney_Ridge%22_(2016) 116 | [amd-ry-list]: https://en.wikipedia.org/wiki/List_of_AMD_Ryzen_processors 117 | [recovery-shyvana]: https://cros.tech/device/shyvana 118 | [recovery-jinlon]: https://cros.tech/device/jinlon 119 | [recovery-voxel]: https://cros.tech/device/voxel 120 | [recovery-gumboz]: https://cros.tech/device/gumboz 121 | [cros-tech]: https://cros.tech/ 122 | [cros-official]: https://cros-updates-serving.appspot.com/ 123 | [vboot-utils]: https://aur.archlinux.org/packages/vboot-utils 124 | [auto-brightness]: https://chromium.googlesource.com/chromiumos/platform2/+/master/power_manager/docs/screen_brightness.md 125 | [brunch-toolkit]: https://github.com/WesBosch/brunch-toolkit 126 | [bite-dasher]: https://github.com/BiteDasher/brcr-update 127 | 128 | 129 | [decon-icon-24]: ./Images/decon_icon-24.png 130 | [decon-icon-512]: ./Images/decon_icon-512.png 131 | [terminal-icon-24]: ./Images/terminal_icon-24.png 132 | [terminal-icon-512]: ./Images/terminal_icon-512.png 133 | [settings-icon-512]: ./Images/settings_icon-512.png 134 | [windows-img]: https://img.icons8.com/color/24/000000/windows-10.png 135 | [linux-img]: https://img.icons8.com/color/24/000000/linux--v1.png 136 | 137 | 138 | [linux-guide]: ./Readme/install-with-linux.md 139 | [windows-guide]: ./Readme/install-with-windows.md 140 | [troubleshooting-and-faqs]: ./Readme/troubleshooting-and-faqs.md 141 | [compatibility]: ./README.md#supported-hardware 142 | [changing-kernels]: ./Readme/troubleshooting-and-faqs.md#kernels 143 | [framework-options]: ./Readme/troubleshooting-and-faqs.md#framework-options 144 | [releases-tab]: https://github.com/sebanc/brunch/releases 145 | [latest-release]: https://github.com/sebanc/brunch/releases/latest 146 | [brunch-der]: https://github.com/sebanc/brunch/raw/master/brunch.der 147 | [secure-boot]: ./Readme/install-with-linux.md#secure-boot 148 | 149 | -------------------------------------------------------------------------------- /Readme/Building.md: -------------------------------------------------------------------------------- 1 | # Brunch principle 2 | 3 | The Brunch framework purpose is to create a generic x86_64 ChromeOS image from an official recovery image. To do so, it uses a 1GB ROOTC partition (containing custom kernels, an initramfs, the swtpm binaries, userspace patches and config files) and a specific EFI partition to boot from it. 4 | 5 | The source directory is composed of: 6 | - the 3 scripts used to build the framework, 7 | - Different Brunch Linux kernels based on ChromiumOS release including specific ChromeOS and surface devices patches (in the kernels directory), 8 | - An "efi-partition" folder containing shim and GRUB and the specific GRUB config, 9 | - An "extra-firmwares" directory to include firmware files which are not available in the mainline kernel firmware git (the mainline kernel firmware files are downloaded during the build process), 10 | - A script folder which contains sub-scripts used during the build process and the Brunch initramfs script, 11 | - A patches folder which contains the patches which will be applied by the initramfs to the ChromeOS rootfs, 12 | - An "alsa-ucm-conf" folder which contains common alsa ucm files for better sound support. 13 | - A few additional binaries in the "packages" folder. 14 | 15 | The build script will copy the rootfs from a ChromeOS recovery image, chroot into it, and install the brunch toolchain in order to: 16 | - build a few programs (notably efibootmgr, swtpm, nano) 17 | - copy all added alsa ucm files, firmware files and patches. (stored in ROOTC image), 18 | - copy the install script which will be used to create the ChromeOS image (chromeos-install.sh), 19 | - create the ROOTC partition image, 20 | - create 2 different efi partitions ("efi_secure.img" with secure boot support and "efi_legacy.img" for older devices). 21 | 22 | From there, to create the ChromeOS image, the install script will only have to: 23 | - create partitions, 24 | - copy the ChromeOS recovery image partitions to this device, 25 | - copy the ROOTC partition which contains the framework, 26 | - replace the EFI partition. 27 | 28 | At boot, GRUB will load the kernel present on ROOTC partition and launch the initramfs which is responsible for adding all the userspace patches to the standard ChromeOS rootfs before booting it, this process takes place: 29 | - on the first boot, 30 | - when the ROOTC partition is modified, 31 | - when an update has been applied. 32 | 33 | ## Getting the source 34 | 35 | Clone the branch you want to use (usually the latest) and enter the source directory: 36 | 37 | ``` 38 | git clone https://github.com/sebanc/brunch.git -b < ChromeOS version e.g. r103 > 39 | cd brunch 40 | ``` 41 | 42 | ## Build instructions 43 | 44 | Building the framework is currently only possible under Linux (should work with any distro). 45 | 46 | To build the release package, you need to have: 47 | - root access, 48 | - the `pv` package installed, 49 | - 16 GB free disk space available, 50 | - an internet connection. 51 | 52 | The build process consist of 3 successive steps (only the last step needs to be run as root): 53 | - preparing the kernels source: 54 | `./prepare_kernels.sh` 55 | - building the kernels: 56 | `./build_kernels.sh` 57 | - building the brunch package: 58 | `sudo bash build_brunch.sh` 59 | 60 | 4. Verify that everything worked well. You should have an "out" directory containing the brunch_< version >_.tar.gz archive. 61 | 62 | -------------------------------------------------------------------------------- /Readme/install-with-linux.md: -------------------------------------------------------------------------------- 1 |
2 | 3 | 4 | [![License][license-shield]][license-url] 5 | [![Issues][issues-shield]][issues-url] 6 | [![Discord][discord-shield]][discord-url] 7 | 8 |

9 | 10 | Logo 11 | 12 |

13 |

Install Brunch with Linux

14 | 15 | 16 | # USB installations 17 | This guide is for installing Brunch to a USB (or other disk) using Linux. This guide should be compatible with Linux Live USBs for quick installations as well. To begin, boot into the Linux distro of your choice and click the dropdown below to continue. 18 | 19 |
20 | Click to open Brunch USB guide 21 | 22 | ### Requirements 23 | - Root access. 24 | - Target Disk/USB must be 16gb minimum. 25 | - `pv`, `tar`, `unzip` and `cgpt` packages. 26 | - A [compatible PC][compatibility] to boot Brunch on. 27 | - An entry level understanding of the linux terminal. 28 | - This guide aims to make this process as easy as possible, but knowing the basics is expected. 29 | 30 | ### Recoveries 31 | 1. Download a recovery suitable for your CPU. The list below can help you select one. You do *not* need to select a recovery that matches the latest Brunch release number, the most recent avaliable is typically fine. 32 | 33 | #### Intel 34 | * 8th gen & 9th gen: "[shyvana][recovery-shyvana]" for Intel / "[bobba][recovery-bobba]" for Celeron. 35 | * 10th gen: "[jinlon][recovery-jinlon]". 36 | * 11th gen & above: "[voxel][recovery-voxel]". 37 | #### AMD 38 | * Ryzen: "[gumboz][recovery-gumboz]". 39 | 40 | Recoveries can be found by clicking the above links. They can also be found by going to [cros.tech][cros-tech] and searching for the recovery you want. 41 | 42 | After selecting the recovery you want, you can select a specific release. Posted releases may be behind the current release, this is normal and you can update into the current release later. It is usually suggested to use the latest release avaliable. 43 | 44 | ### Gathering Files 45 | 2. Download the Brunch files from this GitHub repository. Do not use files found on other sites or linked in videos online. The [releases tab][releases-tab] can be found at the bottom of the right-hand column on the main GitHub page, but it is generally suggested to use the [latest release][latest-release]. 46 | 47 | When downloading a release, select the brunch...tar.gz file from the assets at the bottom of the release post. You do not need the source code files, do not download them. 48 | 49 | ### Prepare the Terminal 50 | 3. Once both files have been downloaded, the Brunch release and your chosen ChromeOS recovery, open a terminal. In most Linux distros you can just press **ctrl + alt + t** to open it quickly. 51 | 4. Make sure that pv, cgpt, tar and unzip are installed. 52 | 53 | ```sudo apt update && sudo apt -y install pv cgpt tar unzip``` 54 | 55 | * My example uses `apt`, a package manager for Debian and Ubuntu based distros. If you use Arch, you will need [vboot-utils][vboot-utils] for access to cgpt and a different package manager may be needed to install the rest. 56 | 57 | 4b. Some Linux releases may require the `universe` repo to install some of the above dependencies. If you get any errors about a dependency being unavaliable, add the `universe` repo with this command, and then try the previous step again afterwards. 58 | 59 | ```sudo add-apt-repository universe``` 60 | 61 | 5. After all dependencies have been installed, `cd` into the directory where your files were downloaded. For most users this will be `~/Downloads` 62 | 63 | ```cd ~/Downloads``` 64 | 65 | 6. Extract the Brunch archive using `tar` 66 | * Replace `brunch_filename.tar.gz` with the file's actual filename. 67 | 68 | ```tar zxvf brunch_filename.tar.gz``` 69 | 70 | 7. Extract the ChromeOS recovery using `unzip` 71 | * Replace `chromeos_filename.bin.zip` with the file's actual filename. 72 | 73 | ```unzip chromeos_filename.bin.zip``` 74 | 75 | Once completed, you will have 4 new files from the brunch archive, and a recovery bin that we will use in the next step. 76 | 77 | ### Selecting a Target Disk 78 | 8. Before continuing, you will need to know what disk you want to install to. Be absolutely sure **before** you continue, this installation will erase **everything** on that disk, including other partitions. The disk must be at least 16 GB, or the installation will fail. There are several ways to determine which disk is your target, in my example I'll be using `lsblk`. 79 | 80 | ```lsblk -e7``` 81 | 82 | This command will show your disks, and the partitions on them. It will also show their sizes and if they are currently mounted. Use this information to determine which disk is your target. 83 | 84 | *** 85 | 86 | #### Tips: 87 | * Your target will **never** be zram or a loop device. 88 | * Some PCs may require RAID to be disabled before showing your disks correctly. 89 | * For this installation, a USB is treated the same as any HDD or SSD. 90 | * If there is an EFI mountpoint on a disk that disk is your boot disk. 91 | * You **cannot** install Brunch directly onto the same disk you are currently booting from. 92 | * When doing a singleboot installation, your target will **not** be a partition. This method installs to the *entire* disk. 93 | 94 | ### Install Brunch 95 | 96 | 9. Once you've determined your target disk, you're ready to install Brunch. 97 | * As before, replace `chromeos_filename.bin` with the bin file's actual filename. 98 | * You will also replace `disk` with your target disk. (Such as `sdb`, `mmcblk0` or `nvme0n1` for example) 99 | 100 | ```sudo bash chromeos-install.sh -src chromeos_filename.bin -dst /dev/disk``` 101 | 102 | The script will ask for confirmation. If you're ready to install, type `yes` into the prompt. 103 | 104 | The installation may take some time depending on the speed of your target disk, please be patient. There may be a couple of GPT Header errors, which can be safely ignored. Depending on the Linux distro you are doing, the system may automatically mount some of the new partitions the script made. You can safely close these windows. 105 | 106 | The installation will report that ChromeOS was installed when it is finished. Before closing the terminal, make sure that there are no additional errors in the terminal. If there are no errors, then you are good to go! 107 | 108 | ### Next Steps 109 | If you installed using a Linux Live USB or installed to a second internal disk, then you should be ready to boot into Brunch without a USB. If you've installed to a USB, keep it plugged in and reboot. It is normal for the first boot to take a very long time, please be patient. 110 | 111 | * The first boot is the best time to setup anything important such as [changing kernels][changing-kernels] or [framework options][framework-options] by selecting the "ChromeOS (Settings)" boot option. 112 | * If you have any issues, it is strongly advised to check out the [Brunch Configuration Menu][edit-brunch-config] for possible patches or solutions. 113 | 114 |
115 | 116 | *** 117 | 118 | 119 | # Singleboot installations 120 | This guide is for installing Brunch to a disk using a Brunch USB. This guide requires having a working Brunch USB to initiate the install, you can make one by following the [guide above][brunch-usb-guide-lin]. To begin, boot into a working Brunch USB and click the dropdown below to continue. 121 | 122 |
123 | Click to open singleboot guide 124 | 125 | ### Requirements 126 | - Root access. 127 | - Target Disk must be 16 GB minimum. 128 | - Working Brunch USB. 129 | - A [compatible PC][compatibility] to boot Brunch on. 130 | - An entry level understanding of the linux terminal. 131 | - This guide aims to make this process as easy as possible, but knowing the basics is expected. 132 | 133 | ### Selecting a Target Disk 134 | 135 | 1. Log into ChromeOS, and switch to the TTY2 terminal with **Ctrl + Alt + F2**, then login as `root`. 136 | 137 | 2. Before continuing, you will need to know what disk you want to install to. Be absolutely sure **before** you continue, this installation will erase **everything** on that disk, including other partitions. The disk must be at least 16 GB, or the installation will fail. There are several ways to determine which disk is your target, in my example I'll be using `lsblk`. 138 | 139 | ```lsblk -e7``` 140 | 141 | This command will show your disks, and the partitions on them. It will also show their sizes and if they are currently mounted. Use this information to determine which disk is your target. 142 | 143 | *** 144 | 145 | #### Tips: 146 | 147 | * Your target will **never** be zram or a loop device. 148 | * Some PCs may require RAID to be disabled before showing your disks correctly. 149 | * For this installation, a USB is treated the same as any HDD or SSD. 150 | * If there is an EFI mountpoint on a disk that disk is your boot disk. 151 | * You **cannot** install Brunch directly onto the same disk you are currently booting from. 152 | * When doing a singleboot installation, your target will **not** be a partition. This method installs to the *entire* disk. 153 | 154 | *** 155 | 156 | ### Install Brunch 157 | 158 | 3. Once you've determined your target disk, you're ready to install Brunch. 159 | * You will replace `disk` with your target disk. (Such as `sdb`, `mmcblk0` or `nvme0n1` for example) 160 | 161 | `chromeos-install -dst /dev/disk` 162 | 163 | The script will ask for confirmation. If you're ready to install, type `yes` into the prompt. 164 | 165 | The installation may take some time depending on the speed of your target disk, please be patient. There may be a couple of GPT Header errors, which can be safely ignored. 166 | 167 | The installation will report that ChromeOS was installed when it is finished. Before closing the terminal, make sure that there are no additional errors in the terminal. If there are no errors, then you are good to go! 168 | 169 | ### Next Steps 170 | 171 | It is normal for the first boot to take a very long time, please be patient. 172 | 173 | * The first boot is the best time to setup anything important such as [changing kernels][changing-kernels] or [framework options][framework-options] by selecting the "ChromeOS (Settings)" boot option. 174 | * If you have any issues, it is strongly advised to check out the [Brunch Configuration Menu][edit-brunch-config] for possible patches or solutions. 175 | 176 |
177 | 178 | *** 179 | 180 | # Dualboot installations 181 | This guide is for installing Brunch to a partition using Linux. This guide is *not* compatible with Linux Live USBs, you should be using an already installed distro. To begin, boot into the Linux distro of your choice and click the dropdown below to continue. 182 | 183 |
184 | Click to open dualboot guide 185 | 186 | ### Requirements 187 | - Root access. 188 | - Target partition must be 16gb minimum, unencrypted, and formatted as NTFS or EXT4 189 | - `pv`, `tar`, `unzip` and `cgpt` packages. 190 | - A [compatible PC][compatibility] to boot Brunch on. 191 | - An entry level understanding of the linux terminal. 192 | - This guide aims to make this process as easy as possible, but knowing the basics is expected. 193 | - Grub2 Bootloader 194 | 195 | ### Recoveries 196 | 1. Download a recovery suitable for your CPU. The list below can help you select one. You do *not* need to select a recovery that matches the latest Brunch release number, the most recent avaliable is typically fine. 197 | 198 | #### Intel 199 | * 8th gen & 9th gen: "[shyvana][recovery-shyvana]" for Intel / "[bobba][recovery-bobba]" for Celeron. 200 | * 10th gen: "[jinlon][recovery-jinlon]". 201 | * 11th gen & above: "[voxel][recovery-voxel]". 202 | #### AMD 203 | * Ryzen: "[gumboz][recovery-gumboz]". 204 | 205 | Recoveries can be found by clicking the above links. They can also be found by going to [cros.tech][cros-tech] and searching for the recovery you want. 206 | 207 | After selecting the recovery you want, you can select a specific release. Posted releases may be behind the current release, this is normal and you can update into the current release later. It is usually suggested to use the latest release avaliable. 208 | 209 | ### Gathering Files 210 | 2. Download the Brunch files from this GitHub repository. Do not use files found on other sites or linked in videos online. The [releases tab][releases-tab] can be found at the bottom of the right-hand column on the main GitHub page, but it is generally suggested to use the [latest release][latest-release]. 211 | 212 | When downloading a release, select the brunch...tar.gz file from the assets at the bottom of the release post. You do not need the source code files, do not download them. 213 | 214 | ### Prepare the Terminal 215 | 3. Once both files have been downloaded, the Brunch release and your chosen ChromeOS recovery, open a terminal. In most Linux distros you can just press **ctrl + alt + t** to open it quickly. 216 | 4. Make sure that pv, cgpt, tar and unzip are installed. 217 | 218 | ```sudo apt update && sudo apt -y install pv cgpt tar unzip``` 219 | 220 | * My example uses `apt`, a package manager for Debian and Ubuntu based distros. If you use Arch, you will need [vboot-utils][vboot-utils] for access to cgpt and a different package manager may be needed to install the rest. 221 | 222 | 4b. Some Linux releases may require the `universe` repo to install some of the above dependencies. If you get any errors about a dependency being unavaliable, add the `universe` repo with this command, and then try the previous step again afterwards. 223 | 224 | ```sudo add-apt-repository universe``` 225 | 226 | 5. After all dependencies have been installed, `cd` into the directory where your files were downloaded. For most users this will be `~/Downloads` 227 | 228 | ```cd ~/Downloads``` 229 | 230 | 6. Extract the Brunch archive using `tar` 231 | * Replace `brunch_filename.tar.gz` with the file's actual filename. 232 | 233 | ```tar zxvf brunch_filename.tar.gz``` 234 | 235 | 7. Extract the ChromeOS recovery using `unzip` 236 | * Replace `chromeos_filename.bin.zip` with the file's actual filename. 237 | 238 | ```unzip chromeos_filename.bin.zip``` 239 | 240 | Once completed, you will have 4 new files from the brunch archive, and a recovery bin that we will use in the next step. 241 | 242 | ### Selecting a Target Partition 243 | 8. Before continuing, you will need to know what partition you want to install to. The partition must be at least 16 GB, or the installation will fail. There are several ways to determine which partition is your target, in my example I'll be using `lsblk`. 244 | 245 | ```lsblk -e7``` 246 | 247 | This command will show your disks, and the partitions on them. It will also show their sizes and if they are currently mounted. Use this information to determine which partition is your target. 248 | 249 | *** 250 | 251 | #### Tips: 252 | * Your target will **never** be zram or a loop device. 253 | * Some PCs may require RAID to be disabled before showing your disks correctly. 254 | * If there is an EFI mountpoint on a disk that disk is your boot disk. 255 | * When doing a dualboot installation, your target will be a partition. This method creates an img file on that partition. 256 | * The target partition does *not* need to be on the same disk as your linux install. 257 | * If you have not made a partition yet, *make one before continuing.* 258 | 259 | ### Mount the Partition 260 | 261 | 9. After determining your target partition, make a directory to mount it onto. 262 | 263 | ```mkdir -p ~/tmpmount``` 264 | 265 | 10. Then mount the partition to that mountpoint. 266 | * Replace `part` with the partition's actual name. (Such as `sda3`, `mmcblk0p5` or `nvme0n1p4` for example) 267 | 268 | ```sudo mount /dev/part ~/tmpmount``` 269 | 270 | ### Install Brunch 271 | 272 | 11. Once you've mounted your target partition, you're ready to install Brunch. 273 | * As before, replace `chromeos_filename.bin` with the bin file's actual filename. 274 | * You will also replace `size` with a whole number. (Such as `14`, `20`, or `100` for example) 275 | * The number must be a *minimum* of 14, but *less* than the avaliable space on your partition in GB. 276 | 277 | ```sudo bash chromeos-install.sh -src chromeos_filename.bin -dst ~/tmpmount/chromeos.img -s size``` 278 | 279 | The script will ask for confirmation. If you're ready to install, type `yes` into the prompt. 280 | 281 | The installation may take some time depending on the speed of your target disk, please be patient. There may be a couple of GPT Header errors, which can be safely ignored. If you are told that there is not enough space to install, reduce the number at the end of your command until it fits. It is normal that the img cannot take the entire space of the partition, as some of that space is reserved by the system. 282 | 283 | The installation will report that ChromeOS was installed when it is finished. Before continuing, make sure that there are no additional errors in the terminal. If there are no errors, then you are good to continue! 284 | 285 | ### Setting up Grub 286 | 287 | 12. Copy the Grub Boot Entries that are displayed in the terminal. (All of the text *between* the lines of asterisks `********`) There will be two of them together, you should copy both entries as they are both used by Brunch. 288 | 289 | 13. Create a copy of your existing 40_custom file. 290 | 291 | ```sudo cp /etc/grub.d/40_custom /etc/grub.d/99_brunch``` 292 | 293 | 14. Open the `99_brunch` file in an editor. For this guide we'll be using `nano` but you can use `gedit`, `vi`, or any editor of your choice. 294 | * If you do not have an editor, you can install `nano` with this command: `sudo apt install nano` 295 | 296 | ```sudo nano /etc/grub.d/99_brunch``` 297 | 298 | 15. Paste the Grub Boot Entries that you copied at the *end* of this file. These boot entries must be *after* the code that is already in this file, *do not remove the existing lines of code*. 299 | 300 | 16. Save and close this file. In `nano` you'll exit by pressing **Ctrl + X** then **Y** to save. Then press **Enter** to confirm. 301 | 302 | 17. After saving, commit the new entries to Grub. 303 | 304 | ```sudo update-grub``` 305 | 306 | 18. At this point, you can unmount the target partition. 307 | 308 | ```sudo umount ~/tmpmount``` 309 | 310 | ### Secure Boot 311 | 312 | 19. If you have secure boot enabled, you should download the [secure boot key][brunch-der] from this repo and enroll the key. 313 | 314 | ```sudo mokutil --import brunch.der``` 315 | 316 | ### Next Steps 317 | It is normal for the first boot to take a very long time, please be patient. 318 | 319 | * The first boot is the best time to setup anything important such as [changing kernels][changing-kernels] or [framework options][framework-options] by selecting the "ChromeOS (Settings)" boot option. 320 | * If you have any issues, it is strongly advised to check out the [Brunch Configuration Menu][edit-brunch-config] for possible patches or solutions. 321 | 322 | 323 |
324 | 325 | *** 326 | 327 | # [Troubleshooting and Support][troubleshooting-and-faqs] 328 | 329 | See the full [Troubleshooting and Support][troubleshooting-and-faqs] page if you're having issues. 330 | 331 | ### Additional Tips 332 | * If you're having trouble booting a Brunch USB, make sure that UEFI is enabled in the BIOS. 333 | * Some PCs require a key to be held when booting to boot from USB or that USB booting is enabled in the BIOS 334 | * The first boot can take up to an hour on some hardware. Brunch does not typically freeze on the Brunch logo. If you are seeing the Brunch logo, the system is _probably_ still booting. 335 | * If your PC is stuck on the ChromeOS logo (White background), it is likely that you've got an incompatible dedicated GPU. 336 | * If you get a blue screen saying "Verification failed" you can either disable secure boot in your bios settings, or [enroll the secure boot key][secure-boot]. 337 | * To enroll the key directly from a USB, select OK -> Enroll key from disk -> EFI-SYSTEM -> brunch.der -> Continue and reboot. 338 | * If the system reboots _itself_ when booting normally, then Brunch has run into an error and you may need to do some advanced troubleshooting. 339 | 340 | In case you run into issues while installing or using Brunch, you can find support on Discord: 341 | 342 | [![Discord][discord-shield]][discord-url] 343 | 344 | 345 | ## Looking for the Windows guide? 346 | ### [![Install with Windows][windows-img]][windows-guide] [Install with Windows][windows-guide] 347 | 348 | 349 | 350 | [license-shield]: https://img.shields.io/github/license/sebanc/brunch?label=License&logo=Github&style=flat-square 351 | [license-url]: ../LICENSE 352 | [forks-shield]: https://img.shields.io/github/forks/sebanc/brunch?label=Forks&logo=Github&style=flat-square 353 | [forks-url]: https://github.com/sebanc/brunch/fork 354 | [stars-shield]: https://img.shields.io/github/stars/sebanc/brunch?label=Stars&logo=Github&style=flat-square 355 | [stars-url]: https://github.com/sebanc/brunch/stargazers 356 | [issues-shield]: https://img.shields.io/github/issues/sebanc/brunch?label=Issues&logo=Github&style=flat-square 357 | [issues-url]: https://github.com/sebanc/brunch/issues 358 | [pulls-shield]: https://img.shields.io/github/issues-pr/sebanc/brunch?label=Pull%20Requests&logo=Github&style=flat-square 359 | [pulls-url]: https://github.com/sebanc/brunch/pulls 360 | [discord-shield]: https://img.shields.io/badge/Discord-Join-7289da?style=flat-square&logo=discord&logoColor=%23FFFFFF 361 | [discord-url]: https://discord.gg/x2EgK2M 362 | 363 | 364 | [croissant]: https://github.com/imperador/chromefy 365 | [swtpm]: https://github.com/stefanberger/swtpm 366 | [linux-surface]: https://github.com/linux-surface/linux-surface 367 | [chromebrew]: https://github.com/skycocker/chromebrew 368 | [intel-cpus]: https://en.wikipedia.org/wiki/Intel_Core 369 | [intel-list]: https://en.wikipedia.org/wiki/List_of_Intel_CPU_microarchitectures 370 | [atom-cpus]: https://en.wikipedia.org/wiki/Intel_Atom 371 | [atom-list]: https://en.wikipedia.org/wiki/List_of_Intel_Atom_microprocessors 372 | [amd-sr-list]: https://en.wikipedia.org/wiki/List_of_AMD_accelerated_processing_units#%22Stoney_Ridge%22_(2016) 373 | [amd-ry-list]: https://en.wikipedia.org/wiki/List_of_AMD_Ryzen_processors 374 | [recovery-bobba]: https://cros.tech/device/bobba 375 | [recovery-shyvana]: https://cros.tech/device/shyvana 376 | [recovery-jinlon]: https://cros.tech/device/jinlon 377 | [recovery-voxel]: https://cros.tech/device/voxel 378 | [recovery-gumboz]: https://cros.tech/device/gumboz 379 | [cros-tech]: https://cros.tech/ 380 | [cros-official]: https://cros-updates-serving.appspot.com/ 381 | [vboot-utils]: https://aur.archlinux.org/packages/vboot-utils 382 | [rufus-link]: https://rufus.ie/ 383 | [etcher-link]: https://www.balena.io/etcher/ 384 | [grub2win]: https://sourceforge.net/projects/grub2win/ 385 | 386 | 387 | [decon-icon-24]: ../Images/decon_icon-24.png 388 | [decon-icon-512]: ../Images/decon_icon-512.png 389 | [terminal-icon-24]: ../Images/terminal_icon-24.png 390 | [terminal-icon-512]: ../Images/terminal_icon-512.png 391 | [settings-icon-512]: ../Images/settings_icon-512.png 392 | [windows-img]: https://img.icons8.com/color/24/000000/windows-10.png 393 | [linux-img]: https://img.icons8.com/color/24/000000/linux--v1.png 394 | 395 | 396 | [windows-guide]: ./install-with-windows.md 397 | [linux-guide]: ./install-with-linux.md 398 | [troubleshooting-and-faqs]: ./troubleshooting-and-faqs.md 399 | [compatibility]: ../README.md#supported-hardware 400 | [changing-kernels]: ./troubleshooting-and-faqs.md#kernels 401 | [framework-options]: ./troubleshooting-and-faqs.md#framework-options 402 | [releases-tab]: https://github.com/sebanc/brunch/releases 403 | [latest-release]: https://github.com/sebanc/brunch/releases/latest 404 | [brunch-der]: https://github.com/sebanc/brunch/raw/main/brunch.der 405 | [secure-boot]: ./install-with-linux.md#secure-boot 406 | [brunch-usb-guide-win]: ./install-with-windows.md#usb-installations 407 | [brunch-usb-guide-lin]: ./install-with-linux.md#usb-installations 408 | [edit-brunch-config]: ./troubleshooting-and-faqs.md#brunch-configuration-menu 409 | -------------------------------------------------------------------------------- /Readme/install-with-windows.md: -------------------------------------------------------------------------------- 1 |
2 | 3 | 4 | [![License][license-shield]][license-url] 5 | [![Issues][issues-shield]][issues-url] 6 | [![Discord][discord-shield]][discord-url] 7 | 8 |

9 | 10 | Logo 11 | 12 |

13 |

Install Brunch with Windows

14 | 15 | 16 | # USB installations 17 | This guide is for installing Brunch to a USB (or other disk) using Windows. This guide is also required when singlebooting. To begin, boot into Windows and click the dropdown below to continue. 18 | 19 |
20 | Click to open Brunch USB guide 21 | 22 | ### Requirements 23 | - Administrator access. 24 | - Target Disk/USB must be 16 GB minimum. 25 | - You will also need about 16 GB of free space in your Windows installation. 26 | - A linux installation via WSL2 27 | - `pv`, `tar`, `unzip` and `cgpt` packages. 28 | - A [compatible PC][compatibility] to boot Brunch on. 29 | - An entry level understanding of the linux terminal. 30 | - This guide aims to make this process as easy as possible, but knowing the basics is expected. 31 | 32 | ### Recoveries 33 | 1. Download a recovery suitable for your CPU. The list below can help you select one. You do *not* need to select a recovery that matches the latest Brunch release number, the most recent avaliable is typically fine. 34 | 35 | #### Intel 36 | * 8th gen & 9th gen: "[shyvana][recovery-shyvana]" for Intel / "[bobba][recovery-bobba]" for Celeron. 37 | * 10th gen: "[jinlon][recovery-jinlon]". 38 | * 11th gen & above: "[voxel][recovery-voxel]". 39 | #### AMD 40 | * Ryzen: "[gumboz][recovery-gumboz]". 41 | 42 | Recoveries can be found by clicking the above links. They can also be found by going to [cros.tech][cros-tech] and searching for the recovery you want. 43 | 44 | After selecting the recovery you want, you can select a specific release. Posted releases may be behind the current release, this is normal and you can update into the current release later. It is usually suggested to use the latest release avaliable. 45 | 46 | ### Gathering Files 47 | 2. Download the Brunch files from this GitHub repository. Do not use files found on other sites or linked in videos online. The [releases tab][releases-tab] can be found at the bottom of the right-hand column on the main GitHub page, but it is generally suggested to use the [latest release][latest-release]. 48 | 49 | When downloading a release, select the brunch...tar.gz file from the assets at the bottom of the release post. You do not need the source code files, do not download them. 50 | 51 | Before continuing, you will need a linux distro installed from the Microsoft Store using WSL2, and the distro must be set up and ready to use. Please refer to online resources for this as the setup can be complicated for some systems. 52 | 53 | ### Prepare the Terminal 54 | 3. Once both files have been downloaded, the Brunch release and your chosen ChromeOS recovery, Launch WSL2. 55 | 4. Make sure that pv, cgpt, tar and unzip are installed. 56 | 57 | ```sudo apt update && sudo apt -y install pv cgpt tar unzip``` 58 | * My example uses `apt`, a package manager for Debian and Ubuntu based distros. If you use Arch, you will need [vboot-utils][vboot-utils] for access to cgpt and a different package manager may be needed to install the rest. 59 | 60 | 4b. Some Linux releases may require the `universe` repo to install some of the above dependencies. If you get any errors about a dependency being unavaliable, add the `universe` repo with this command, and then try the previous step again afterwards. 61 | 62 | ```sudo add-apt-repository universe``` 63 | 64 | 5. After all dependencies have been installed, `cd` into the directory where your files were downloaded. 65 | * Replace `username` with your *Windows* username. 66 | * The linux terminal is Case Sensitive, be mindful of capital letters. 67 | 68 | ```cd /mnt/c/Users/username/Downloads``` 69 | 70 | 6. Extract the Brunch archive using `tar` 71 | * Replace `brunch_filename.tar.gz` with the file's actual filename. 72 | 73 | ```tar zxvf brunch_filename.tar.gz``` 74 | 75 | 7. Extract the ChromeOS recovery using `unzip` 76 | * Replace `chromeos_filename.bin.zip` with the file's actual filename. 77 | 78 | ```unzip chromeos_filename.bin.zip``` 79 | 80 | Once completed, you will have 4 new files from the brunch archive, and a recovery bin that we will use in the next step. 81 | 82 | ### Install Brunch 83 | 84 | 8. Once you've got your files ready, you're ready to install Brunch. 85 | * As before, replace `chromeos_filename.bin` with the bin file's actual filename. 86 | 87 | ```sudo bash chromeos-install.sh -src chromeos_filename.bin -dst chromeos.img``` 88 | 89 | The script will ask for confirmation. If you're ready to install, type `yes` into the prompt. 90 | 91 | The installation may take some time depending on the speed of your disk, please be patient. There may be a couple of GPT Header errors, which can be safely ignored. 92 | 93 | The installation will report that ChromeOS was installed when it is finished. Before closing the terminal, make sure that there are no additional errors in the terminal. If there are no errors, then you are good to go! 94 | 95 | ### Making the USB 96 | 97 | 9. Since WSL2 does not have direct disk access, we make an img with WSL2 and then use another program such as [Rufus][rufus-link] or [Etcher][etcher-link] to write the disk to a USB. Open the program of your choice, select the chromeos.img in your Downloads folder and write it to your USB. 98 | 99 | ### Next Steps 100 | 101 | If you installed to a USB or a second internal disk, then you should be ready to boot into Brunch. If you've installed to a USB, keep it plugged in and reboot. It is normal for the first boot to take a very long time, please be patient. 102 | 103 | * The first boot is the best time to setup anything important such as [changing kernels][changing-kernels] or [framework options][framework-options] by selecting the "ChromeOS (Settings)" boot option. 104 | * If you have any issues, it is strongly advised to check out the [Brunch Configuration Menu][edit-brunch-config] for possible patches or solutions. 105 | * At this point, your device may incorrectly state that your installation is only 14 GB, regardless of it's actual size. This can be fixed by opening a developer shell on the startup screen with **Ctrl + Alt + F2**. 106 | * Log in as `root` there should be no password. 107 | * Enter `resize-data` then reboot the PC when it's finished. Your reported size should now be accurate. 108 | 109 | ## Secure Boot 110 | 111 | 10. If secure boot is enabled, a blue screen saying `Verification failed: (15) Access Denied` may appear upon boot. 112 | * To enroll the key directly from a USB, select OK -> Enroll key from disk -> EFI-SYSTEM -> brunch.der -> Continue and reboot. 113 | 114 |
115 | 116 | *** 117 | 118 | # Singleboot installations 119 | This guide is for installing Brunch to a disk using a Brunch USB. This guide requires having a working Brunch USB to initiate the install, you can make one by following the [guide above][brunch-usb-guide-win]. To begin, boot into a working Brunch USB and click the dropdown below to continue. 120 | 121 |
122 | Click to open singleboot guide 123 | 124 | ### Requirements 125 | - Administrator access. 126 | - Target Disk must be 16 GB minimum. 127 | - Working Brunch USB. 128 | - A [compatible PC][compatibility] to boot Brunch on. 129 | - An entry level understanding of the linux terminal. 130 | - This guide aims to make this process as easy as possible, but knowing the basics is expected. 131 | 132 | ### Selecting a Target Disk 133 | 134 | 1. Log into ChromeOS, and switch to the TTY2 terminal with **Ctrl + Alt + F2**, then login as `root`. 135 | 136 | 2. Before continuing, you will need to know what disk you want to install to. Be absolutely sure **before** you continue, this installation will erase **everything** on that disk, including other partitions. The disk must be at least 16 GB, or the installation will fail. There are several ways to determine which disk is your target, in my example I'll be using `lsblk`. 137 | 138 | ```lsblk -e7``` 139 | 140 | This command will show your disks, and the partitions on them. It will also show their sizes and if they are currently mounted. Use this information to determine which disk is your target. 141 | 142 | *** 143 | 144 | #### Tips: 145 | 146 | * Your target will **never** be zram or a loop device. 147 | * Some PCs may require RAID to be disabled before showing your disks correctly. 148 | * For this installation, a USB is treated the same as any HDD or SSD. 149 | * If there is an EFI mountpoint on a disk that disk is your boot disk. 150 | * You **cannot** install Brunch directly onto the same disk you are currently booting from. 151 | * When doing a singleboot installation, your target will **not** be a partition. This method installs to the *entire* disk. 152 | 153 | *** 154 | 155 | ### Install Brunch 156 | 157 | 3. Once you've determined your target disk, you're ready to install Brunch. 158 | * You will replace `disk` with your target disk. (Such as `sdb`, `mmcblk0` or `nvme0n1` for example) 159 | 160 | `chromeos-install -dst /dev/disk` 161 | 162 | The script will ask for confirmation. If you're ready to install, type `yes` into the prompt. 163 | 164 | The installation may take some time depending on the speed of your target disk, please be patient. There may be a couple of GPT Header errors, which can be safely ignored. 165 | 166 | The installation will report that ChromeOS was installed when it is finished. Before closing the terminal, make sure that there are no additional errors in the terminal. If there are no errors, then you are good to go! 167 | 168 | ### Next Steps 169 | 170 | It is normal for the first boot to take a very long time, please be patient. 171 | 172 | * The first boot is the best time to setup anything important such as [changing kernels][changing-kernels] or [framework options][framework-options] by selecting the "ChromeOS (Settings)" boot option. 173 | * If you have any issues, it is strongly advised to check out the [Brunch Configuration Menu][edit-brunch-config] for possible patches or solutions. 174 | 175 |
176 | 177 | *** 178 | 179 | # Dualboot installations 180 | This guide is for installing Brunch to a partition using Windows WSL2. 181 | 182 |
183 | Click to open dualboot guide 184 | 185 | ### Requirements 186 | - Administrator access. 187 | - Target partition must be 16gb minimum, unencrypted (bitlocker disabled), and formatted as NTFS. 188 | - A linux installation vis WSL2 189 | - `pv`, `tar`, `unzip` and `cgpt` packages. 190 | - A [compatible PC][compatibility] to boot Brunch on. 191 | - An entry level understanding of the linux terminal. 192 | - This guide aims to make this process as easy as possible, but knowing the basics is expected. 193 | 194 | ### Recoveries 195 | 1. Download a recovery suitable for your CPU. The list below can help you select one. You do *not* need to select a recovery that matches the latest Brunch release number, the most recent avaliable is typically fine. 196 | 197 | #### Intel 198 | * 8th gen & 9th gen: "[shyvana][recovery-shyvana]" for Intel / "[bobba][recovery-bobba]" for Celeron. 199 | * 10th gen: "[jinlon][recovery-jinlon]". 200 | * 11th gen & above: "[voxel][recovery-voxel]". 201 | #### AMD 202 | * Ryzen: "[gumboz][recovery-gumboz]". 203 | 204 | Recoveries can be found by clicking the above links. They can also be found by going to [cros.tech][cros-tech] and searching for the recovery you want. 205 | 206 | After selecting the recovery you want, you can select a specific release. Posted releases may be behind the current release, this is normal and you can update into the current release later. It is usually suggested to use the latest release avaliable. 207 | 208 | ### Gathering Files 209 | 2. Download the Brunch files from this GitHub repository. Do not use files found on other sites or linked in videos online. The [releases tab][releases-tab] can be found at the bottom of the right-hand column on the main GitHub page, but it is generally suggested to use the [latest release][latest-release]. 210 | 211 | When downloading a release, select the brunch...tar.gz file from the assets at the bottom of the release post. You do not need the source code files, do not download them. 212 | 213 | Before continuing, you will need a linux distro installed from the Microsoft Store using WSL2, and the distro must be set up and ready to use. Please refer to online resources for this as the setup can be complicated for some systems. 214 | 215 | ### Prepare the Terminal 216 | 3. Once both files have been downloaded, the Brunch release and your chosen ChromeOS recovery, Launch WSL2. 217 | 4. Make sure that pv, cgpt, tar and unzip are installed. 218 | 219 | ```sudo apt update && sudo apt -y install pv cgpt tar unzip``` 220 | * My example uses `apt`, a package manager for Debian and Ubuntu based distros. If you use Arch, you will need [vboot-utils][vboot-utils] for access to cgpt and a different package manager may be needed to install the rest. 221 | 222 | 4b. Some Linux releases may require the `universe` repo to install some of the above dependencies. If you get any errors about a dependency being unavaliable, add the `universe` repo with this command, and then try the previous step again afterwards. 223 | 224 | ```sudo add-apt-repository universe``` 225 | 226 | 5. After all dependencies have been installed, `cd` into the directory where your files were downloaded. 227 | * Replace `username` with your *Windows* username. 228 | * The linux terminal is Case Sensitive, be mindful of capital letters. 229 | 230 | ```cd /mnt/c/Users/username/Downloads``` 231 | 232 | 6. Extract the Brunch archive using `tar` 233 | * Replace `brunch_filename.tar.gz` with the file's actual filename. 234 | 235 | ```tar zxvf brunch_filename.tar.gz``` 236 | 237 | 7. Extract the ChromeOS recovery using `unzip` 238 | * Replace `chromeos_filename.bin.zip` with the file's actual filename. 239 | 240 | ```unzip chromeos_filename.bin.zip``` 241 | 242 | Once completed, you will have 4 new files from the brunch archive, and a recovery bin that we will use in the next step. 243 | 244 | ### Install Brunch 245 | 246 | 8. Once you've got your files ready, you're ready to install Brunch. 247 | * As before, replace `chromeos_filename.bin` with the bin file's actual filename. 248 | * You will also replace `size` with a whole number. (Such as `14`, `20`, or `100` for example) 249 | * The number must be a *minimum* of 14, but *less* than the avaliable space on your partition in GB. 250 | 251 | Make a directory to install Brunch, for example: 252 | - run `mkdir /mnt/c/Users/username/brunch` if you want to install brunch in your home folder on C: partition. 253 | - or `mkdir /mnt/d/brunch` if you want to install brunch in the D: partition. 254 | 255 | Then launch the installer providing "-dst" argument with the name of the image file to be created (in your brunch directory): 256 | ```sudo bash chromeos-install.sh -src chromeos_filename.bin -dst /mnt/c/Users/username/brunch/chromeos.img -s size``` 257 | 258 | The installation may take some time depending on the speed of your target disk, please be patient. There may be a couple of GPT Header errors, which can be safely ignored. If you are told that there is not enough space to install, reduce the number at the end of your command until it fits. It is normal that the img cannot take the entire space of the partition, as some of that space is reserved by the system. 259 | 260 | When the installer asks you for the type of install, type "dualboot" in the terminal and press "Enter" to continue. 261 | 262 | The installation will report that ChromeOS was installed when it is finished. Before continuing, make sure that there are no additional errors in the terminal. If there are no errors, then you are good to continue! 263 | 264 | ### Set up Grub2Win 265 | 10. Install [Grub2win][grub2win] if you have not already, then launch the program. (Windows Defender sometimes will flag Grub2Win as a virus and remove it) 266 | 267 | 11. Click on the `Manage Boot Menu` button, then click `Chrome` under 'Import Configuration File'. 268 | 269 | * Select your chromeos.img.grub.txt file that we created earlier. 270 | * Click `Import Selected Items` 271 | * Your entry will not be saved unless you click `Apply`. 272 | 273 | ### Prevent Windows from locking the NTFS partition 274 | 12. Disable encryption / hibernation 275 | 276 | ChromeOS will not be bootable and / or stable if you do not perform the below actions (Refer to Windows online resources if needed): 277 | - Ensure that bitlocker is disabled on the drive which contains the ChromeOS image or disable it. 278 | - Disable fast startup. 279 | - Disable hibernation. 280 | 281 | At this point, you are ready to reboot and you'll be greeted by the Grub2win menu instead of booting into Windows. 282 | 283 | ### Next Steps 284 | 285 | It is normal for the first boot to take a very long time, please be patient. 286 | 287 | * The first boot is the best time to setup anything important such as [changing kernels][changing-kernels] or [framework options][framework-options] by selecting the "ChromeOS (Settings)" boot option. 288 | * If you have any issues, it is strongly advised to check out the [Brunch Configuration Menu][edit-brunch-config] for possible patches or solutions. 289 | 290 |
291 | 292 | *** 293 | 294 | # [Troubleshooting and Support][troubleshooting-and-faqs] 295 | 296 | See the full [Troubleshooting and Support][troubleshooting-and-faqs] page if you're having issues. 297 | 298 | ### Additional Tips 299 | * If you're having trouble booting a Brunch USB, make sure that UEFI is enabled in the BIOS. 300 | * Some PCs require a key to be held when booting to boot from USB or that USB booting is enabled in the BIOS 301 | * The first boot can take up to an hour on some hardware. Brunch does not typically freeze on the Brunch logo. If you are seeing the Brunch logo, the system is _probably_ still booting. 302 | * If your PC is stuck on the ChromeOS logo (White background), it is likely that you've got an incompatible dedicated GPU. 303 | * If you get a blue screen saying "Verification failed" you can either disable secure boot in your bios settings, or [enroll the secure boot key][secure-boot]. 304 | * To enroll the key directly from a USB, select OK -> Enroll key from disk -> EFI-SYSTEM -> brunch.der -> Continue and reboot. 305 | * If the system reboots _itself_ when booting normally, then Brunch has run into an error and you may need to do some advanced troubleshooting. 306 | 307 | In case you run into issues while installing or using Brunch, you can find support on Discord: 308 | 309 | [![Discord][discord-shield]][discord-url] 310 | 311 | 312 | ## Looking for the Linux guide? 313 | ### [![Install with Linux][linux-img]][linux-guide] [Install with Linux][Linux-guide] 314 | 315 | 316 | 317 | [license-shield]: https://img.shields.io/github/license/sebanc/brunch?label=License&logo=Github&style=flat-square 318 | [license-url]: ../LICENSE 319 | [forks-shield]: https://img.shields.io/github/forks/sebanc/brunch?label=Forks&logo=Github&style=flat-square 320 | [forks-url]: https://github.com/sebanc/brunch/fork 321 | [stars-shield]: https://img.shields.io/github/stars/sebanc/brunch?label=Stars&logo=Github&style=flat-square 322 | [stars-url]: https://github.com/sebanc/brunch/stargazers 323 | [issues-shield]: https://img.shields.io/github/issues/sebanc/brunch?label=Issues&logo=Github&style=flat-square 324 | [issues-url]: https://github.com/sebanc/brunch/issues 325 | [pulls-shield]: https://img.shields.io/github/issues-pr/sebanc/brunch?label=Pull%20Requests&logo=Github&style=flat-square 326 | [pulls-url]: https://github.com/sebanc/brunch/pulls 327 | [discord-shield]: https://img.shields.io/badge/Discord-Join-7289da?style=flat-square&logo=discord&logoColor=%23FFFFFF 328 | [discord-url]: https://discord.gg/x2EgK2M 329 | 330 | 331 | [croissant]: https://github.com/imperador/chromefy 332 | [swtpm]: https://github.com/stefanberger/swtpm 333 | [linux-surface]: https://github.com/linux-surface/linux-surface 334 | [chromebrew]: https://github.com/skycocker/chromebrew 335 | [intel-cpus]: https://en.wikipedia.org/wiki/Intel_Core 336 | [intel-list]: https://en.wikipedia.org/wiki/List_of_Intel_CPU_microarchitectures 337 | [atom-cpus]: https://en.wikipedia.org/wiki/Intel_Atom 338 | [atom-list]: https://en.wikipedia.org/wiki/List_of_Intel_Atom_microprocessors 339 | [amd-sr-list]: https://en.wikipedia.org/wiki/List_of_AMD_accelerated_processing_units#%22Stoney_Ridge%22_(2016) 340 | [amd-ry-list]: https://en.wikipedia.org/wiki/List_of_AMD_Ryzen_processors 341 | [recovery-bobba]: https://cros.tech/device/bobba 342 | [recovery-shyvana]: https://cros.tech/device/shyvana 343 | [recovery-jinlon]: https://cros.tech/device/jinlon 344 | [recovery-voxel]: https://cros.tech/device/voxel 345 | [recovery-gumboz]: https://cros.tech/device/gumboz 346 | [cros-tech]: https://cros.tech/ 347 | [cros-official]: https://cros-updates-serving.appspot.com/ 348 | [vboot-utils]: https://aur.archlinux.org/packages/vboot-utils 349 | [rufus-link]: https://rufus.ie/ 350 | [etcher-link]: https://www.balena.io/etcher/ 351 | [grub2win]: https://sourceforge.net/projects/grub2win/ 352 | 353 | 354 | [decon-icon-24]: ../Images/decon_icon-24.png 355 | [decon-icon-512]: ../Images/decon_icon-512.png 356 | [terminal-icon-24]: ../Images/terminal_icon-24.png 357 | [terminal-icon-512]: ../Images/terminal_icon-512.png 358 | [settings-icon-512]: ../Images/settings_icon-512.png 359 | [windows-img]: https://img.icons8.com/color/24/000000/windows-10.png 360 | [linux-img]: https://img.icons8.com/color/24/000000/linux--v1.png 361 | 362 | 363 | [windows-guide]: ./install-with-windows.md 364 | [linux-guide]: ./install-with-linux.md 365 | [troubleshooting-and-faqs]: ./troubleshooting-and-faqs.md 366 | [compatibility]: ../README.md#supported-hardware 367 | [changing-kernels]: ./troubleshooting-and-faqs.md#kernels 368 | [framework-options]: ./troubleshooting-and-faqs.md#framework-options 369 | [releases-tab]: https://github.com/sebanc/brunch/releases 370 | [latest-release]: https://github.com/sebanc/brunch/releases/latest 371 | [brunch-der]: https://github.com/sebanc/brunch/raw/main/brunch.der 372 | [secure-boot]: ./install-with-linux.md#secure-boot 373 | [brunch-usb-guide-win]: ./install-with-windows.md#usb-installations 374 | [brunch-usb-guide-lin]: ./install-with-linux.md#usb-installations 375 | [edit-brunch-config]: ./troubleshooting-and-faqs.md#brunch-configuration-menu 376 | -------------------------------------------------------------------------------- /Readme/troubleshooting-and-faqs.md: -------------------------------------------------------------------------------- 1 |
2 | 3 | 4 | [![License][license-shield]][license-url] 5 | [![Issues][issues-shield]][issues-url] 6 | [![Discord][discord-shield]][discord-url] 7 | 8 | 9 |

10 | 11 | Logo 12 | 13 |

14 |

Troubleshooting and Support

15 | 16 | # Common Issues 17 | 18 | *** 19 | 21 | 22 | ### The instructions are too difficult to follow! 23 | * ChromeOS is based on linux, most troubleshooting will require some familiarity with basic linux commands. It is strongly suggested that users are comfortable with linux before attempting an installation. If you are strugging with a specific step or would like to suggest changes to the guide, please reach out to our community for assistance. 24 | 25 | [![Discord][discord-shield]][discord-url] 26 | 27 | ### I followed a video tutorial, now I'm having issues. 28 | * Video guides are very frequently out of date or use potentially dangerous scripts. For the most up to date information and guides, be sure to read over this github page thouroughly *before* asking for help. 29 | 30 | ### My computer will not boot a Brunch USB, and I've followed all of the instructions correctly! 31 | * Some devices (notably Surface Go) will not boot a valid USB flash drive / SD card with secure boot on even if the shim binary is signed. For those devices, you will need to disable secure boot in your bios settings and use the legacy EFI bootloader by adding the `-l` parameter when running the chromeos-install.sh script. 32 | 33 | ### The first boot and the ones after a framework change or an update are incredibly long! 34 | * Unfortunately, the Brunch framework has to rebuild itself by copying the original rootfs, modules and firmware files after each significant change. The time this process takes depends mostly on your USB flash drive / SD card write speed. You may try with one that has better write speed or use the dual boot method to install it on your HDD. 35 | 36 | ### ChromeOS reboots randomly! 37 | * This can in theory be due to a lot of things. However, the most likely reason is that your USB flash drive / SD card is too slow. You may try with one that has better write speed or use the dual boot method to install it on your HDD. 38 | 39 | ### Some apps, like Netflix, do not appear on the playstore or don't run properly! 40 | * In order to have access to the ChromeOS shell, ChromeOS is started in developer mode by default. If you have a stable enough system, you can manually remove `cros_debug` from grub.cfg on the 12th partiton and then do a Powerwash (ChromeOS mechanism which will wipe all your data partition) to disable developer mode. This will remove access to the Crosh shell and certain other features though. 41 | 42 | ### Some android apps on the Playstore show as incompatible with my device! 43 | * Some Playstore apps are not compatible with genuine Chromebooks so this is probably normal. ChromeOS is not Android, so some apps and games are not optimized or avaliable. 44 | 45 | ### A new update is avaliable, is it safe to update? 46 | * ChromeOS updates can be unpredictable, especially on Brunch devices. Even if it's declared safe by other users, you should *always* have backups ready in case there is an issue while updating or if the update has serious bugs on your hardware. 47 | 48 | ### My Touchpad, Touchscreen, Wifi or other hardware is not working properly! 49 | * ChromeOS is not optimized for every device. Brunch has several avaliable framework options and multiple customized kernels avaliable further down on this page to help with these issues. If you're still having issues, you can reach out to other users on one of our communities for help. 50 | 51 | ### Grub doens't appears on the boot options 52 | * Some older devices (usually Acer, Asus and Samsung) can't detect Brunch's Grub. To solve this, you can manually assign grub on the BIOS but if your bios doesn't have this option you can use `efibootmgr` to create a boot entry for grub. 53 | 54 | [![Discord][discord-shield]][discord-url] 55 | 56 | *** 57 | 58 | # Brunch Configuration Menu 59 | 60 | *** 61 | 62 | The Brunch Configuration menu is a new feature avaliable in Brunch 93 and higher, this menu will allow users to set and controll options easily without needing to manually edit files themselves. 63 | 64 | ## How to Use 65 | 66 |
67 | Click for Screenshots and Instructions 68 | 69 | *** 70 | 71 | The Brunch Configuration Menu can be accessed directly from Grub using the "ChromeOS (settings)" boot option or while logged into a TTY using the `sudo edit-brunch-config` command. 72 | * To access TTY2, press **Ctrl + Alt + F2** and login as `chronos`. 73 | ![Crosh][bcm-crosh] 74 | 75 | Once you've entered the Brunch Configuration Menu you will be greeted by several pages of options. 76 | * Use the arrow keys to move the cursor up or down. 77 | * Use the spacebar to select an option. 78 | * An empty set [ ] means the option is *not* selected. 79 | * A filled set [x] means the option *has* been selected. 80 | * When you're ready to continue, press the Enter key. 81 | * You won't be able to go back, but this menu can be opened again later. 82 | * You *do not* need to select something from every page. 83 |
84 | 85 | ## Framework Options 86 | 87 |
88 | Click to learn about framework options 89 | 90 | *** 91 | 92 | The first two pages of the Brunch Configuration Menu are for selecting Framework Options. These options act as patches and can be used to add more features or support to your installation, you can select multiple with the Spacebar, or use the Enter key to continue. Continue scrolling for details about what each option does. 93 | ![Framework Options 1][bcm-fo1] 94 | ![Framework Options 2][bcm-fo2] 95 | 96 | Some device specific options can be enabled through brunch configuration menu: 97 | - "enable_updates": allow native ChromeOS updates (use at your own risk: ChromeOS will be updated but not the Brunch framework/kernel which might render your ChromeOS install unstable or even unbootable), 98 | - "pwa": use this option to enable the brunch PWA: 99 | - You can install the original one from https://sebanc.github.io/brunch-pwa/ or the ITESaurabh version available at: https://itesaurabh.github.io/brunch-pwa, 100 | - "android_init_fix": alternative init to support devices on which the android container fails to start with the standard init, 101 | - "mount_internal_drives": allows automatic mounting of HDD partitions in ChromeOS: 102 | - Android media server will scan those drives which will cause high CPU usage until it has finished, it might take hours depending on your data, 103 | - Partition label will be used if it exists, 104 | - "chromebook_audio": enable audio on EOL chromebook devices using the brunch recommended recovery image, 105 | - "native_chromebook_image": enable it to use brunch on a non-EOL chromebook using its official recovery image, make sure to also select the chromebook kernel version used by your device in ChromeOS, 106 | - "broadcom_wl": enable this option if you need the broadcom_wl module, 107 | - "iwlwifi_backport": enable this option if your intel wireless card is not supported natively in the kernel, 108 | - "rtl8188eu": enable this option if you have a rtl8188eu wireless card/adapter, 109 | - "rtl8188fu": enable this option if you have a rtl8188fu wireless card/adapter, 110 | - "rtl8192eu": enable this option if you have a rtl8192eu wireless card/adapter, 111 | - "rtl8723bu": enable this option if you have a rtl8723bu wireless card/adapter, 112 | - "rtl8723de": enable this option if you have a rtl8723de wireless card/adapter, 113 | - "rtl8723du": enable this option if you have a rtl8723du wireless card/adapter, 114 | - "rtl8812au": enable this option if you have a rtl8812au wireless card/adapter, 115 | - "rtl8814au": enable this option if you have a rtl8814au wireless card/adapter, 116 | - "rtl8821ce": enable this option if you have a rtl8821ce wireless card/adapter, 117 | - "rtl8821cu": enable this option if you have a rtl8821cu wireless card/adapter, 118 | - "rtl88x2bu": enable this option if you have a rtl88x2bu wireless card/adapter, 119 | - "rtbth": enable this option if you have a RT3290/RT3298LE bluetooth device, 120 | - "ipts_touchscreen": enable support for ipts touchscreen (SP4/5/6/7,SB1/2), 121 | - "ithc_touchscreen": enable support for ithc touchscreen (SP7+,SB3 and above), 122 | - "goodix": improve goodix touchscreens support, 123 | - "invert_camera_order": use this option if your camera order is inverted, 124 | - "no_camera_config": if your camera does not work you can try this option which disables the camera config, 125 | - "oled_display": enable this option if you have an oled display (use with kernel 5.10), 126 | - "acpi_power_button": try this option if long pressing the power button does not display the power menu, 127 | - "alt_touchpad_config": try this option if you have touchpad issues, 128 | - "alt_touchpad_config2": another option to try if you have touchpad issues, 129 | - "internal_mic_fix": fix for internal mic on some devices, 130 | - "internal_mic_fix2": alternative fix for internal mic on some devices, 131 | - "sysfs_tablet_mode": allow to control tablet mode from sysfs: 132 | - `echo 1 | sudo tee /sys/bus/platform/devices/tablet_mode_switch.0/tablet_mode` to activate it or use 0 to disable it, 133 | - "force_tablet_mode": same as above except tablet mode is enabled by default on boot, 134 | - "suspend_s3": disable suspend to idle (S0ix) and use S3 suspend instead, 135 | - "advanced_als": [default ChromeOS auto-brightness][auto-brightness] is very basic: 136 | - This option activates more auto-brightness levels (based on the Pixel Slate implementation). 137 | 138 |
139 | 140 | ## Kernels 141 | 142 |
143 | Click to learn about kernels 144 | 145 | *** 146 | 147 | Brunch has several precompiled kernels avaliable for users, you can select one from the Brunch Configuration Menu by highlighting the kernel you want, then pressing enter. If you are unsure which to choose, 5.4 is the default kernel for Brunch. Continue scrolling for more information about each avaliable option. 148 | 149 | WARNING: Changing kernel can prevent you from logging into your ChromeOS account, in which case a powerwash is the only solution (**Ctrl + Alt + Shift + R** at the login screen). Therefore, before switching to a different kernel, make sure you have a backup of all your data. 150 | ![Kernels][bcm-kernel] 151 | 152 | Several kernels can be enabled throught the configuration menu: 153 | - LTS kernels (6.1, 5.15, 5.10, 5.4, 4.19): use those kernels for non-chromebook devices, 6.1 is the default. 154 | - Chromebook kernels (6.1, 5.15, 5.10, 5.4, 4.19): For Chromebook devices, select the same kernel version used by your device in ChromeOS. 155 | 156 |
157 | 158 | 159 | ## Kernel command line parameters 160 | 161 |
162 | Click to learn about kernel line parameters 163 | 164 | *** 165 | 166 | These are optional parameters that are not needed by every user. Some commonly used options are selectable, and more can be input manually. If you do not need any command line parameters, you can just press Enter to skip these sections. 167 | ![Command Line Paramters][bcm-cmd1] 168 | ![Custom Parameters][bcm-cmd2] 169 | 170 | The most common kernel command line parameters are listed below: 171 | - "enforce_hyperthreading=1": improve performance by disabling a ChromeOS security feature and forcing hyperthreading everywhere (even in crositini). 172 | - "i915.enable_fbc=0 i915.enable_psr=0": if you want to use crouton (needed with kernel 5.4). 173 | - "psmouse.elantech_smbus=1": fix needed for some elantech touchpads. 174 | - "psmouse.synaptics_intertouch=1": enables gestures with more than 2 fingers on some touchpad models. 175 | 176 | Additional kernel parameters can also be added manually from the configuration menu. 177 | 178 |
179 | 180 | ## Verbose Mode 181 | 182 |
183 | Click to learn about Verbose Mode 184 | 185 | *** 186 | 187 | Brunch has a Verbose Mode, formerly called Debug Mode. Enabling this boot option will disable any selected Brunch Bootsplash and display a log while booting. This is particularly useful for debugging and solving issues that may prevent your system from booting. To enable Verbose Mode you must enter `yes` at the prompt, then press enter. 188 | ![Verbose Mode][bcm-debug] 189 | 190 |
191 | 192 | ## Brunch Bootsplashes 193 | 194 |
195 | Click to learn about Brunch Bootsplashes 196 | 197 | *** 198 | 199 | Brunch Bootsplashes can be selected using the Brunch Configuration Menu, these determine the logo visible while Brunch is booting. (before the ChromeOS logo appears) These bootsplashes *will not appear* if you have enabled Verbose Mode above. You can select any of these options with the Enter key. 200 | ![Brunch Bootsplash][bcm-splash] 201 | 202 |
203 | Click for previews of each avaliable bootsplash option 204 | 205 | *** 206 | 207 | Currently avaliable bootsplashes are below, the "light" options will show as a framed window while booting. 208 | 209 |
210 | Default 211 | 212 | ![bs-default1] 213 | ![bs-default2] 214 |
215 | 216 |
217 | Blank 218 | 219 | ![bs-blank] 220 | 221 | (What did you expect?) 222 |
223 | 224 |
225 | Brunchbook 226 | 227 | ![bs-bb1] 228 | ![bs-bb2] 229 |
230 | 231 |
232 | Colorful 233 | 234 | ![bs-color1] 235 | ![bs-color2] 236 |
237 | 238 |
239 | Croissant 240 | 241 | ![bs-croi1] 242 | ![bs-croi2] 243 |
244 | 245 |
246 | Neon Blue 247 | 248 | ![bs-nb1] 249 | ![bs-nb2] 250 |
251 | 252 |
253 | Neon Green 254 | 255 | ![bs-ng1] 256 | ![bs-ng2] 257 |
258 | 259 |
260 | Neon Pink 261 | 262 | ![bs-np1] 263 | ![bs-np2] 264 |
265 | 266 |
267 | Neon Red 268 | 269 | ![bs-nr1] 270 | ![bs-nr2] 271 |
272 | 273 |
274 | 275 |
276 | 277 | 278 | 279 | ## Saving Changes 280 | 281 |
282 | Click for more info 283 | 284 | *** 285 | 286 | The last page of the Brunch Configuration Menu will allow you to confirm your changes. Upon hitting enter, your PC will reboot. The next time you boot into Brunch, it *will* be a long boot. (Just like when you first installed) This is normal. If the options you selected were not correct, or you want to change things back, you can reopen the Brunch Configuration Menu and start over. 287 | ![Summary][bcm-summary] 288 | 289 |
290 | 291 | *** 292 | 293 | # Updates 294 | 295 | *** 296 | 297 | It is currently recommended to only update ChromeOS when the matching version of the Brunch framework has been released, however it's not a strict requirement that Brunch and ChromeOS be the same version. 298 | 299 | 300 | ## How to update Brunch and ChromeOS together 301 | 302 |
303 | Click to learn how to update Brunch and ChromeOS together 304 | 305 | *** 306 | 307 | The easiest way to update Brunch and ChromeOS is to use the [Brunch PWA][brunch-pwa-info], although it's also possible to update manually. 308 | 309 | To manually update Brunch and ChromeOS together: 310 | * Download the [latest Brunch release][latest-release] 311 | * Download the [latest recovery][cros-tech] matching your install and extract the bin. 312 | * Open a TTY with **Crtl + Alt + F2** and login as `chronos`. 313 | * Run the built in command to update Brunch. 314 | * Replace `brunch_archive.tar.gz` with the file's actual filename. 315 | * Replace `recovery.bin` with the file's actual filename. 316 | 317 | ```sudo chromeos-update -r ~/Downloads/recovery.bin -f ~/Downloads/brunch_archive.tar.gz``` 318 | * Restart ChromeOS after the update finishes. 319 | 320 | Brunch and ChromeOS can also be updated with [BiteDasher's Script][bite-dasher] 321 | 322 |
323 | 324 | 325 | ## How to update ChromeOS 326 | 327 |
328 | Click to learn how to update ChromeOS 329 | 330 | *** 331 | 332 | The easiest way to update ChromeOS is to enable the `enable_updates` framework option, then update directly from the Settings page. 333 | 334 | To enable the framework option: 335 | * Open a TTY with **Crtl + Alt + F2** and login as `chronos`. 336 | * Enter `sudo edit-brunch-config` to open the Brunch Configuration Menu described above. 337 | * Select `enable_updates` with the spacebar, then continue through the menu with the enter key. 338 | * When finished, the Brunch Configuration Menu will prompt to restart ChromeOS. 339 | * Update from the standard ChromeOS settings page after rebooting. 340 | 341 |
342 | 343 | 344 | 345 | ## How to update Brunch 346 | 347 |
348 | Click to learn how to update Brunch 349 | 350 | *** 351 | 352 | The easiest way to update Brunch is to use the [Brunch PWA][brunch-pwa-info], although it's also possible to update manually. 353 | 354 | To manually update Brunch: 355 | * Download the [latest Brunch release][latest-release] 356 | * Open a TTY with **Crtl + Alt + F2** and login as `chronos`. 357 | * Run the built in command to update Brunch. 358 | * Replace `brunch_archive.tar.gz` with the file's actual filename. 359 | 360 | ```sudo chromeos-update -f ~/Downloads/brunch_archive.tar.gz``` 361 | * Restart ChromeOS after the update finishes. 362 | 363 |
364 | 365 | 366 | 367 | [license-shield]: https://img.shields.io/github/license/sebanc/brunch?label=License&logo=Github&style=flat-square 368 | [license-url]: ../LICENSE 369 | [forks-shield]: https://img.shields.io/github/forks/sebanc/brunch?label=Forks&logo=Github&style=flat-square 370 | [forks-url]: https://github.com/sebanc/brunch/fork 371 | [stars-shield]: https://img.shields.io/github/stars/sebanc/brunch?label=Stars&logo=Github&style=flat-square 372 | [stars-url]: https://github.com/sebanc/brunch/stargazers 373 | [issues-shield]: https://img.shields.io/github/issues/sebanc/brunch?label=Issues&logo=Github&style=flat-square 374 | [issues-url]: https://github.com/sebanc/brunch/issues 375 | [pulls-shield]: https://img.shields.io/github/issues-pr/sebanc/brunch?label=Pull%20Requests&logo=Github&style=flat-square 376 | [pulls-url]: https://github.com/sebanc/brunch/pulls 377 | [discord-shield]: https://img.shields.io/badge/Discord-Join-7289da?style=flat-square&logo=discord&logoColor=%23FFFFFF 378 | [discord-url]: https://discord.gg/x2EgK2M 379 | 380 | 381 | [croissant]: https://github.com/imperador/chromefy 382 | [swtpm]: https://github.com/stefanberger/swtpm 383 | [linux-surface]: https://github.com/linux-surface/linux-surface 384 | [chromebrew]: https://github.com/skycocker/chromebrew 385 | [intel-cpus]: https://en.wikipedia.org/wiki/Intel_Core 386 | [intel-list]: https://en.wikipedia.org/wiki/List_of_Intel_CPU_microarchitectures 387 | [atom-cpus]: https://en.wikipedia.org/wiki/Intel_Atom 388 | [atom-list]: https://en.wikipedia.org/wiki/List_of_Intel_Atom_microprocessors 389 | [amd-sr-list]: https://en.wikipedia.org/wiki/List_of_AMD_accelerated_processing_units#%22Stoney_Ridge%22_(2016) 390 | [amd-ry-list]: https://en.wikipedia.org/wiki/List_of_AMD_Ryzen_processors 391 | [recovery-bobba]: https://cros.tech/device/bobba 392 | [recovery-shyvana]: https://cros.tech/device/shyvana 393 | [recovery-jinlon]: https://cros.tech/device/jinlon 394 | [recovery-voxel]: https://cros.tech/device/voxel 395 | [recovery-gumboz]: https://cros.tech/device/gumboz 396 | [cros-tech]: https://cros.tech/ 397 | [cros-official]: https://cros-updates-serving.appspot.com/ 398 | [vboot-utils]: https://aur.archlinux.org/packages/vboot-utils 399 | [auto-brightness]: https://chromium.googlesource.com/chromiumos/platform2/+/master/power_manager/docs/screen_brightness.md 400 | [brunch-toolkit]: https://github.com/WesBosch/brunch-toolkit 401 | [bite-dasher]: https://github.com/BiteDasher/brcr-update 402 | 403 | 404 | [decon-icon-24]: ../Images/decon_icon-24.png 405 | [decon-icon-512]: ../Images/decon_icon-512.png 406 | [terminal-icon-24]: ../Images/terminal_icon-24.png 407 | [terminal-icon-512]: ../Images/terminal_icon-512.png 408 | [settings-icon-512]: ../Images/settings_icon-512.png 409 | [windows-img]: https://img.icons8.com/color/24/000000/windows-10.png 410 | [linux-img]: https://img.icons8.com/color/24/000000/linux--v1.png 411 | 412 | 413 | [bcm-crosh]: ../Images/brunch-config-menu/edit-brunch-config.png 414 | [bcm-fo1]: ../Images/brunch-config-menu/framework-options-1.png 415 | [bcm-fo2]: ../Images/brunch-config-menu/framework-options-2.png 416 | [bcm-kernel]: ../Images/brunch-config-menu/select-kernel.png 417 | [bcm-cmd1]: ../Images/brunch-config-menu/cmd-line-params.png 418 | [bcm-cmd2]: ../Images/brunch-config-menu/custom-params.png 419 | [bcm-debug]: ../Images/brunch-config-menu/verbose-mode.png 420 | [bcm-splash]: ../Images/brunch-config-menu/select-bootsplash.png 421 | [bcm-summary]: ../Images/brunch-config-menu/summary.png 422 | 423 | 424 | [bs-default1]: https://github.com/sebanc/brunch/blob/r97/bootsplashes/default_dark/main.png 425 | [bs-default2]: https://github.com/sebanc/brunch/blob/r97/bootsplashes/default_light/main.png 426 | [bs-blank]: https://github.com/sebanc/brunch/blob/r97/bootsplashes/blank/main.png 427 | [bs-bb1]: https://github.com/sebanc/brunch/blob/r97/bootsplashes/brunchbook_dark/main.png 428 | [bs-bb2]: https://github.com/sebanc/brunch/blob/r97/bootsplashes/brunchbook_light/main.png 429 | [bs-color1]: https://github.com/sebanc/brunch/blob/r97/bootsplashes/colorful_dark/main.png 430 | [bs-color2]: https://github.com/sebanc/brunch/blob/r97/bootsplashes/colorful_light/main.png 431 | [bs-croi1]: https://github.com/sebanc/brunch/blob/r97/bootsplashes/croissant_dark/main.png 432 | [bs-croi2]: https://github.com/sebanc/brunch/blob/r97/bootsplashes/croissant_light/main.png 433 | [bs-nb1]: https://github.com/sebanc/brunch/blob/r97/bootsplashes/neon_blue_dark/main.png 434 | [bs-nb2]: https://github.com/sebanc/brunch/blob/r97/bootsplashes/neon_blue_light/main.png 435 | [bs-ng1]: https://github.com/sebanc/brunch/blob/r97/bootsplashes/neon_green_dark/main.png 436 | [bs-ng2]: https://github.com/sebanc/brunch/blob/r97/bootsplashes/neon_green_light/main.png 437 | [bs-np1]: https://github.com/sebanc/brunch/blob/r97/bootsplashes/neon_pink_dark/main.png 438 | [bs-np2]: https://github.com/sebanc/brunch/blob/r97/bootsplashes/neon_pink_light/main.png 439 | [bs-nr1]: https://github.com/sebanc/brunch/blob/r97/bootsplashes/neon_red_dark/main.png 440 | [bs-nr2]: https://github.com/sebanc/brunch/blob/r97/bootsplashes/neon_red_light/main.png 441 | 442 | 443 | [windows-guide]: ./install-with-windows.md 444 | [linux-guide]: ./install-with-linux.md 445 | [troubleshooting-and-faqs]: ./troubleshooting-and-faqs.md 446 | [compatibility]: ../README.md#supported-hardware 447 | [changing-kernels]: ./troubleshooting-and-faqs.md#kernels 448 | [framework-options]: ./troubleshooting-and-faqs.md#framework-options 449 | [releases-tab]: https://github.com/sebanc/brunch/releases 450 | [latest-release]: https://github.com/sebanc/brunch/releases/latest 451 | [brunch-der]: https://github.com/sebanc/brunch/raw/master/brunch.der 452 | [secure-boot]: ./install-with-linux.md#secure-boot 453 | -------------------------------------------------------------------------------- /brunch.der: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sebanc/brunch/0a6da64458c50cc9ffb8932556e36bbdf9616a44/brunch.der --------------------------------------------------------------------------------