Rename README to README.md

This commit is contained in:
Nathan Friedly
2022-09-01 16:53:27 -04:00
committed by GitHub
parent 74bbd3634e
commit 12d2c20eb9

35
README.md Normal file
View File

@@ -0,0 +1,35 @@
# MiyooCFW Buildroot
The goal of this repo is to build a working root filesystem for MiyooCFW.
However, the filesystem it produces is quite a bit different from what MiyooCFW expects, so we're currently using a prebuilt rootfs that lives in https://github.com/MiyooCFW/sdcard
The current configuration expects an external toolchain to exist in `/opt/miyoo` - download it from https://github.com/MiyooCFW/toolchain/releases or use our docker image.
Using an external toolchain reduces compile time quite a bit, but it can be disabled if you want to compile everything locally.
## Original Buildroot Readme
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 Freenode IRC.
If you would like to contribute patches, please read
https://buildroot.org/manual.html#submitting-patches