1026abbcf9
Buildroot packaging pretty much assumes that the sources it downloads are publicly available. In general, however, Buildroot is also used to download sources from private repositories. Nowadays, that mostly means from a github or gitlab instance. Although git-over-ssh can be used for that, this poses a problem for CI, because the CI runners integrated with github and gitlab only have access to the repository itself, not to other private repositories. And creating ssh key pairs for CI runners is tricky. Therefore, document how standard tools can be used to make private repositories available both to developers and to CI. There are quite a few alternative approaches possible, but they're more complicated or less generically applicable. Signed-off-by: Arnout Vandecappelle <arnout@rnout.be> [Peter: Fix insteadOf example, capitalize SSH/HTTPS] Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
Buildroot is a simple, efficient and easy-to-use tool to generate embedded Linux systems through cross-compilation. The documentation can be found in docs/manual. You can generate a text document with 'make manual-text' and read output/docs/manual/manual.text. Online documentation can be found at http://buildroot.org/docs.html To build and use the buildroot stuff, do the following: 1) run 'make menuconfig' 2) select the target architecture and the packages you wish to compile 3) run 'make' 4) wait while it compiles 5) find the kernel, bootloader, root filesystem, etc. in output/images You do not need to be root to build or run buildroot. Have fun! Buildroot comes with a basic configuration for a number of boards. Run 'make list-defconfigs' to view the list of provided configurations. Please feed suggestions, bug reports, insults, and bribes back to the buildroot mailing list: buildroot@buildroot.org You can also find us on #buildroot on OFTC IRC. If you would like to contribute patches, please read https://buildroot.org/manual.html#submitting-patches