Skip to content

Commit 87e687e

Browse files
committed
Update and rename README to README.md
1 parent b058b0c commit 87e687e

File tree

2 files changed

+70
-26
lines changed

2 files changed

+70
-26
lines changed

README

Lines changed: 0 additions & 26 deletions
This file was deleted.

README.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# WordClock Buildroot
2+
3+
## Requirements
4+
* Check out buildroot requirements: https://buildroot.org/downloads/manual/manual.html#requirement
5+
* About __15GB__ of free disk space
6+
7+
## Compilation
8+
9+
1. Clone repository:
10+
11+
SSH: `git clone [email protected]:OpenLarry/WordClock-Buildroot.git`
12+
13+
HTTP: `git clone https://github.com/OpenLarry/WordClock-Buildroot.git`
14+
2. Change directory:
15+
16+
`cd WordClock-Buildroot`
17+
3. Download submodules:
18+
19+
`git submodule init`
20+
21+
`git submodule update`
22+
4. Set buildroot configuration:
23+
24+
`make olimex_imx233_olinuxino_wordclock_defconfig`
25+
5. Run build process:
26+
27+
`make`
28+
6. Wait. Build time depends on hardware configuration and internet speed.
29+
7. Change into generated output directory:
30+
31+
`cd output/images`
32+
8. Here you can find the SD card image (`sd-card.img`) and all parts of it:
33+
34+
* `u-boot.sd` boot loader
35+
* `uboot-env.bin` boot loader configuration
36+
* `uImage.imx233-olinuxino` linux kernel
37+
* `rootfs.squashfs` root filesystem
38+
39+
9. Copy to SD card:
40+
41+
`dd if=sd-card.img of=/dev/mmcblk0 bs=4096` (replace mmcblk0 with your card reader device)
42+
43+
## About buildroot
44+
45+
Buildroot is a simple, efficient and easy-to-use tool to generate embedded
46+
Linux systems through cross-compilation.
47+
48+
The documentation can be found in docs/manual. You can generate a text
49+
document with 'make manual-text' and read output/docs/manual/manual.text.
50+
Online documentation can be found at http://buildroot.org/docs.html
51+
52+
To build and use the buildroot stuff, do the following:
53+
54+
1. run 'make menuconfig'
55+
2. select the target architecture and the packages you wish to compile
56+
3. run 'make'
57+
4. wait while it compiles
58+
5. find the kernel, bootloader, root filesystem, etc. in output/images
59+
60+
You do not need to be root to build or run buildroot. Have fun!
61+
62+
Buildroot comes with a basic configuration for a number of boards. Run
63+
'make list-defconfigs' to view the list of provided configurations.
64+
65+
Please feed suggestions, bug reports, insults, and bribes back to the
66+
buildroot mailing list: [email protected]
67+
You can also find us on #buildroot on Freenode IRC.
68+
69+
If you would like to contribute patches, please read
70+
https://buildroot.org/manual.html#submitting-patches

0 commit comments

Comments
 (0)