Updated readme with some basic build instructions

This commit is contained in:
Dan Krause 2013-10-19 23:24:40 -05:00
parent 78030b8f0c
commit 4be239ba9c

View file

@ -1,4 +1,34 @@
kcard-buildroot
===============
Buildroot configuration for building a custom rootfs for KeyASIC WifiSD based cards.
Buildroot configuration for building a custom rootfs for KeyASIC WifiSD based cards. This does not currently build a kernel, but that is [planned](https://github.com/dankrause/kcard-buildroot/issues/9). Check the [releases](https://github.com/dankrause/kcard-buildroot/releases) section for pre-built images that are ready to use immediately.
To build your own image on Ubuntu derivatives:
```bash
# install buildroot dependencies (this list may be incomplete - contributions welcome)
sudo apt-get install build-essential bison flex gettext libncurses5-dev texinfo autoconf automake libtool
# download and extract buildroot 2013.08.1
wget http://buildroot.uclibc.org/downloads/buildroot-2013.08.1.tar.bz2
tar -xf buildroot-2013.08.1.tar.bz2
# clone kcard-buildroot
git clone https://github.com/dankrause/kcard-buildroot.git
# create symlinks from buildroot to kcard-buildroot
ln -s ../../kcard-buildroot/board/wifisd buildroot-2013.08.1/board/wifisd
ln -s ../../kcard-buildroot/configs/wifisd_defconfig buildroot-2013.08.1/configs/wifisd_defconfig
# start working with buildroot
cd buildroot-2013.08.1
# tell buildroot to start using the buildroot conf file that comes with kcard-buildroot
make wifisd_defconfig
# build a rootfs
make
```
Once the build is complete, you should have an image (`output/images/initramfs3.gz`) ready for writing to your device. You still need to grab the kernel from [Dmitry Grinberg](http://dmitry.gr/index.php?r=05.Projects&proj=15.%20Transcend%20WiFiSD) if you haven't already.