diff --git a/README b/README index 3e056ec..01894da 100644 --- a/README +++ b/README @@ -1,43 +1,83 @@ -This is the source of the Frugalware LiveCD, FWLive. += FWLive - LiveCD for Frugalware +Janos Kovacs -Building --------- +== Status + +FWLive is a livecd based on Frugalware. This means you can (ideally) take any +Frugalware version, select your favourite packages and build a livecd from +them. Nice, isn't it? ;-) + +FWLive is in a testing status. This means that you can download a +http://frugalware.org/download/frugalware-testing-iso/fwlive-0.7rc2-i686-full.iso[binary +iso] based on the latest Frugalware testing release and you also get the source +(see below). + +== Requirements + +All you need is an installed Frugalware system and root privileges (as you will +build the LiveCD in a chrooted system). + +== Build from scratch + +If you never compiled the FWLive, you need the following steps: + +---- +$ mkdir -p ~/git +$ cd ~/git +$ git clone http://git.frugalware.org/repos/fwlive/.git +$ git clone http://git.frugalware.org/repos/translations/.git +$ cd fwlive +---- + +Check if all referenced repositories are configured. Check the TREE variable in +the file 'config': for example if it contains 'current' then check if current +is enabled as a repository in `/etc/repoman.conf`. + +NOTE: You can place your `fwlive` repository anywhere you want, and if you want +to place your translations repository somewhere else, you just need to edit +po/Makefile. To build the livecd: - $ sudo make +---- +$ sudo make +---- To clean up compiled code in the source dir: - $ sudo make clean +---- +$ sudo make clean +---- To remove the building chroot: - $ sudo make distclean +---- +$ sudo make distclean +---- -From scratch ------------- +== Customizing -If you never compiled the FWLive, you need the following steps: +Have a look at the file named `config`, you can set several configuration +options there. -cd ~ -mkdir -p git -cd git -git clone http://git.frugalware.org/repos/fwlive/.git -git clone http://git.frugalware.org/repos/translations/.git -cd fwlive +== I would like to have support for ... -Check if all referenced repos are configured. Check the TREE variable in the -file 'config': for example if it contains 'current' then check if current is -enabled as a repo in /etc/repoman.conf. +If something does not work, then please contact us! Please also try the git +version before reporting a bug, your problem may be already fixed there. -then read the section titled "Building". +In fact, of course, we wrote this documentation after figured out how to do +this setup, so maybe we left out some steps. If you needed 'any' additional +tricks, then it would be nice to include them here. -NOTE: you can place your fwlive repo anywhere you want, and if you want to -place your translations repo somewhere else, you just need to edit po/Makefile. -Customizing ------------ +== Additional resources -Have a look at the file named 'config', you can set several configuration -options there. +You can reach a gitweb interface +link:http://git.frugalware.org/gitweb/gitweb.cgi?p=fwlive.git;a=summary[here]. + +== Thanks + +Please see the link:AUTHORS[AUTHORS file] for the list of contributors. Feel +free to contact us if you're missing from there! + +// vim: ft=asciidoc