brkas 0.1.0__tar.gz

brkas-0.1.0/COPYING

@@ -0,0 +1,343 @@
+brkas is distributed under the terms of the GNU General Public License,
+reproduced below; either version 2 of the License, or (at your option)
+any later version, as Buildroot.
+
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

brkas-0.1.0/PKG-INFO

@@ -0,0 +1,327 @@
+Metadata-Version: 2.4
+Name: brkas
+Version: 0.1.0
+Summary: kas-like YAML project files for Buildroot
+License-Expression: GPL-2.0-or-later
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: COPYING
+Requires-Dist: PyYAML
+Provides-Extra: schema
+Requires-Dist: jsonschema; extra == "schema"
+Dynamic: license-file
+
+<img src="docs/brkas-logo.png" alt="BRKAS: making Buildroot projects easy" width="100%">
+
+brkas does for [Buildroot](https://buildroot.org) what kas does for Yocto.
+
+You describe your project in a YAML file:
+
+- which Buildroot version to use;
+- which br2-external trees to add;
+- which defconfig to start from;
+- which configuration changes to apply on top of it.
+
+Then brkas downloads everything, configures Buildroot and builds the project with a
+single command.
+
+Here is a small project file:
+
+```yaml
+header:
+  version: 1
+
+buildroot:
+  release: "2026.08.1"
+  sha256: 38a6c152490096018720a9ade379ee1e571c9bf5f93a3657a166566945a98b0d
+
+externals:
+  yabi:
+    url: https://github.com/angeloc/yabi.git
+    refspec: main
+    path: br-yabi
+
+defconfig: arietta_xterm01_yabi
+
+config:
+  BR2_TARGET_GENERIC_HOSTNAME: demo
+```
+
+To build it:
+
+```
+brkas build project.yml
+```
+
+If you know kas, this table shows what each part of kas becomes in brkas:
+
+| kas (Yocto)                      | brkas (Buildroot)                                   |
+|----------------------------------|-----------------------------------------------------|
+| `repos:`                         | `buildroot:` and `externals:`                       |
+| `machine:`, `distro:`            | `defconfig:`                                        |
+| `local_conf_header:`             | `fragments:` (files) and `config:` (single options) |
+| `kas build`, `checkout`, `shell` | `brkas build`, `checkout`, `shell`                  |
+| `kas dump --lock`, lock files    | `brkas dump --lock`, `brkas lock`, `*.lock.yml`     |
+| `kas-container`                  | `brkas-container`                                   |
+| `kas menu`                       | `brkas menuconfig`, `xconfig`                       |
+
+## Installation
+
+```
+pipx install .             # or: pipx install '.[schema]' to also check the project files
+```
+
+This installs two commands, `brkas` and `brkas-container`.
+
+brkas needs Python 3.10 or newer and PyYAML. To build directly on your machine, you also
+need the tools Buildroot itself needs (make, gcc, git and so on). If you use
+`brkas-container` instead, you only need Python and Docker or Podman.
+
+## Quick start
+
+```
+brkas build examples/x86_64.yml
+```
+
+This command:
+
+1. downloads Buildroot 2026.08.1 and checks its SHA-256;
+2. configures a small x86_64 system (`examples/configs/x86_64_defconfig`) that uses the
+   Bootlin prebuilt toolchain, adds SSH (`examples/fragments/ssh.config`) and sets a host
+   name;
+3. builds the result in `build/x86_64`. There is no compiler and no kernel to build, so
+   it only takes a few minutes.
+
+The `examples` directory has more projects:
+
+| File                        | What it shows                                                  |
+|-----------------------------|----------------------------------------------------------------|
+| `x86_64.yml`                | a Buildroot release tarball and a defconfig file of your own   |
+| `aarch64.yml`               | a generic ARM system, with Buildroot cloned from git at a tag  |
+| `arietta-xterm01-yabi.yml`  | a br2-external tree taken from another git repository          |
+
+## The project file
+
+You can split a project into several files. `brkas build a.yml:b.yml` reads `a.yml` first,
+then `b.yml`. Values in `b.yml` replace the ones in `a.yml`.
+
+Here is every section, with comments:
+
+```yaml
+header:
+  version: 1                 # required, always 1 for now
+  includes:                  # other files to read first; this file wins over them
+    - common.yml             # a path, relative to this file
+    - repo: yabi             # or a file inside a repository
+      file: br-yabi/brkas/base.yml
+
+buildroot:                   # where Buildroot comes from, pick one way:
+  url: https://gitlab.com/buildroot.org/buildroot.git
+  refspec: 2026.08.1         #   a git repository, at a branch, tag or commit;
+  # release: "2026.08.1"     #   an official release tarball;
+  # tarball: <url or file>   #   any other tarball;
+  # sha256: <hash>           #   (the expected SHA-256 of the tarball)
+  # dir: ../buildroot        #   a directory you already have, used as it is
+  patches:                   # patches applied after the download
+    fix: patches/buildroot   #   a patch file, or a directory of *.patch files
+    other:                   #   or patches from a repository
+      repo: yabi
+      path: patches/buildroot
+
+externals:                   # br2-external trees, same choices as buildroot:
+  yabi:
+    url: https://github.com/angeloc/yabi.git
+    refspec: main
+    path: br-yabi            # where the external is inside the repository
+  local:
+    dir: ../my-external
+
+defconfig: arietta_xterm01_yabi  # a defconfig name from Buildroot or an external,
+                                 # or a file path (with a /), or {repo:, file:}
+
+fragments:                   # configuration fragments added to the defconfig, in order
+  debug: fragments/debug.config
+  board:
+    repo: yabi
+    file: br-yabi/fragments/x.config
+
+config:                      # single options, applied last
+  BR2_TARGET_GENERIC_HOSTNAME: demo   # strings get quotes automatically
+  BR2_PACKAGE_DROPBEAR: y             # y, n or m
+  BR2_TARGET_ROOTFS_EXT2_SIZE: "128M"
+
+build:
+  dir: build                 # where outputs go (default: build/)
+  name: demo                 # the output directory name (default: the file name)
+  targets: [all]             # what "brkas build" makes by default
+  dl_dir: ~/.cache/brkas/dl  # download cache, shared between projects
+
+env:                         # environment variables for make
+  MAKEFLAGS: -j12            # with BR2_PER_PACKAGE_DIRECTORIES: y, builds
+                             # several packages at the same time
+
+container:                   # default settings for brkas-container
+  image: brkas:0.1.0
+  engine: podman
+  options: [--network=host]
+```
+
+Some rules to know:
+
+- When two files set the same section, their contents are merged. Inside a section, a
+  later value replaces an earlier one.
+- Setting a key to `null` removes it. For example, `fragments: {debug: null}` removes a
+  fragment that an included file added.
+- A path is relative to the file where it is written.
+- Quote values that look like numbers, such as `release: "2026.08"`. Otherwise YAML reads
+  them as numbers and brkas rejects them.
+
+After configuring, brkas checks the result. If an option you asked for is not in the final
+configuration, brkas prints a warning. This usually means the option depends on another
+option that is not enabled.
+
+## Commands
+
+```
+brkas checkout project.yml          # download everything and configure
+brkas build project.yml [targets]   # the same, then build
+brkas shell project.yml [-c cmd]    # open a shell to build other software for the target
+brkas menuconfig project.yml --save fragments/mine.config   # or xconfig
+brkas dump project.yml [--lock]     # print the merged project
+brkas lock project.yml              # write project.lock.yml
+brkas for-all-repos project.yml 'git log -1 --oneline'
+brkas clean project.yml [--all]     # remove the output (--all: the repositories too)
+brkas clean --all                   # remove everything brkas made in the work directory
+brkas clean --cache project.yml     # remove only the download cache (build.dl_dir)
+```
+
+brkas puts the downloaded repositories in the work directory: `buildroot/`, plus one
+directory for each external. Builds go in `build/`. The work directory is the current
+directory, unless you set `--work-dir` or `$BRKAS_WORK_DIR`.
+
+Two options control the repositories:
+
+- `--update` fetches new commits, so that a branch moves forward.
+- `--force` throws away your local changes in the repositories. Without it, brkas stops
+  instead of touching them.
+
+### brkas shell
+
+`brkas shell` opens a bash shell in the output directory, ready to cross-compile other
+software for your target. It loads Buildroot's SDK environment (`host/environment-setup`):
+
+- the cross compiler is in `PATH`;
+- `CC`, `CFLAGS`, `ARCH`, `CROSS_COMPILE` and `KERNELDIR` are set;
+- the `configure` and `cmake` aliases use the right options.
+
+`make` still works in this shell.
+
+The first time, brkas enables the Buildroot option that creates this environment
+(`BR2_PACKAGE_HOST_ENVIRONMENT_SETUP`). If the SDK is not built yet, brkas runs
+`make sdk` before opening the shell. It does the same when the project configuration
+changed since the last SDK, so that the SDK always matches the project. While it builds, brkas shows a spinner and writes
+the build output to `brkas-sdk.log` in the output directory. The option stays enabled
+after that. You can still turn it off in `config:`.
+
+Here is the first `brkas shell` of the x86_64 example, run in the container:
+
+```
+$ brkas-container shell examples/x86_64.yml
+brkas: buildroot: downloading https://buildroot.org/downloads/buildroot-2026.08.1.tar.gz
+brkas: buildroot: unpacking buildroot-2026.08.1.tar.gz
+brkas: configuring /home/user/work/build/x86_64 from x86_64_defconfig
+brkas: building the SDK: make sdk, output in /home/user/work/build/x86_64/brkas-sdk.log
+brkas: building the SDK: done in 01:20
+brkas: shell in /home/user/work/build/x86_64: exit to leave
+ _           _ _     _                 _
+| |__  _   _(_) | __| |_ __ ___   ___ | |_
+| '_ \| | | | | |/ _` | '__/ _ \ / _ \| __|
+| |_) | |_| | | | (_| | | | (_) | (_) | |_
+|_.__/ \__,_|_|_|\__,_|_|  \___/ \___/ \__|
+
+       Making embedded Linux easy!
+
+Some tips:
+* PATH now contains the SDK utilities
+* Standard autotools variables (CC, LD, CFLAGS) are exported
+* Kernel compilation variables (ARCH, CROSS_COMPILE, KERNELDIR) are exported
+* To configure do "./configure $CONFIGURE_FLAGS" or use
+  the "configure" alias
+* To build CMake-based projects, use the "cmake" alias
+
+(brkas) user@cd1fc8f3192e:/home/user/work/build/x86_64$
+```
+
+### brkas menuconfig and xconfig
+
+These commands open Buildroot's configuration tools: `brkas menuconfig`, or `brkas xconfig`
+for the graphical one. xconfig needs Qt 5, and it is not available in `brkas-container`.
+
+When you close the tool, brkas finds what you changed. With `--save FILE`, it writes only
+those changes to a fragment file, which you can then add to `fragments:`.
+
+### Lock files
+
+`brkas lock project.yml` writes `project.lock.yml`. This file records the exact commit
+of every git repository and the SHA-256 of every tarball.
+
+When a lock file sits next to a project file, brkas reads it automatically. If you commit
+the lock file, everyone builds from exactly the same sources.
+
+To move to newer sources, run `brkas lock --update project.yml`, or delete the lock file.
+
+## Building in a container
+
+```
+brkas-container build project.yml   # run any brkas command inside it
+```
+
+The first time, brkas-container builds its image (`brkas:<version>`) from the Dockerfile it
+ships with, which takes a few minutes. Later runs reuse it. `brkas-container --build-image`
+builds it again, for example after updating brkas.
+
+The image is a plain Debian with the packages that the Buildroot manual asks for, cmake,
+and brkas. With cmake in the image, Buildroot does not need to compile its own, and the
+`cmake` alias of `brkas shell` works. When the project builds cmake in the SDK
+(`BR2_PACKAGE_HOST_CMAKE`), the shell uses that one instead. Nothing in it comes from Buildroot, so it can build any Buildroot version.
+
+- The work directory, the project files and the download cache appear inside the
+  container at the same paths as on your machine.
+- The container runs as your user, so the files it creates belong to you.
+- Your home directory has the same path inside the container, so `~` means the same
+  thing. It starts empty: only the directories above are shared from it.
+
+Other directories are not visible inside the container. To work on your own software from
+`brkas-container shell`, share its directory with `--mount DIR` (you can repeat it):
+
+```
+brkas-container --mount ~/src/myapp shell project.yml
+```
+
+The directory appears at the same path inside the container, and you can read and write
+it. So in the shell you can `cd ~/src/myapp` and build it with the cross compiler. The
+option exists only on the command line, so that your local paths stay out of the project
+files.
+
+Nothing of your SSH setup is passed to the container by default. For private
+repositories, there are two options, as in kas-container:
+
+- `--ssh-agent` forwards your running SSH agent to the container;
+- `--ssh-dir DIR` (or `$BRKAS_SSH_DIR`) shares a directory with SSH keys and configuration.
+  The directory is mounted read-only and copied to `~/.ssh` inside the container.
+
+With `--ssh-dir`, the container can read every key in that directory. So it is better to
+use a directory with only the keys the project needs, not your whole `~/.ssh`.
+
+## Tests
+
+```
+python3 -m pytest tests
+```
+
+The integration tests need a Buildroot git tree. They use `$BRKAS_TEST_BUILDROOT`, or
+`~/buildroot` by default.
+
+## License
+
+GPL-2.0-or-later. See COPYING.