Skip to content

Commit 8b9fd1b

Browse files
committed
docs: Added Quickstart info
In order to help bootstrap individuals in using the project a simple quickstart file has been added explaining how to both download buildroot and reference the external repo in the correct way.
1 parent 55044b7 commit 8b9fd1b

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,30 @@ removal of man pages, shared files, and many pieces not germaine to running
77
on an embedded platform. At CoreOS we use Buildroot for the generation of
88
[minimal containers](https://github.com/brianredbeard/minimal_containers) for
99
use with [rkt](https://github.com/coreos/rkt) and Docker.
10+
11+
## Quick Start
12+
13+
To get started using these pieces one should do the following:
14+
15+
Step 1 - Clone [buildroot](https://github.com/buildroot/buildroot):
16+
17+
```
18+
$ git clone [email protected]:buildroot/buildroot.git
19+
```
20+
21+
Step 2 - Clone CoreOS_buildroot (note: this should not be in the buildroot
22+
directory):
23+
24+
```
25+
$ git clone [email protected]:brianredbeard/buildroot.git
26+
```
27+
28+
Step 3 - Reference the `coreos_buildroot` directory from `buildroot`:
29+
30+
```
31+
$ cd buildroot
32+
$ make BR2_EXTERNAL=../coreos_buildroot menuconfig
33+
```
34+
This connects the two repos together and exposes all of the coreos_buildroot
35+
options through the menu option "User-provided options --->"
36+

0 commit comments

Comments
 (0)