Update README.md

pull/23/head
johndah4x0r 2017-07-26 13:34:30 +02:00 committed by GitHub
parent eb41f0ce87
commit 5b7684685f
1 changed files with 31 additions and 31 deletions

View File

@ -11,24 +11,24 @@ the original Linux Live Kit. <http://linux-live.org>
## Before you build: ## Before you build:
- Store Linux Live Kit in a directory which is not going to be included Store Linux Live Kit in a directory which is not going to be included
in your live distro, else it would be copied to it. in your live distro, else it would be copied to it.
The best practice is to make a directory such The best practice is to make a directory such
as for example: '/tmp/a', and put all the files there. as for example: '/tmp/a', and put all the files there.
### NOTE: ### NOTE:
* Make sure to extract and use it on a POSIX-compatible * Make sure to extract and use it on a POSIX-compatible
filesystem (for ex: EXT4), since it will create symlinks filesystem (for ex: EXT4), since it will create symlinks
and such that might not be compatible in for example: FAT and such that might not be compatible in for example: FAT
and such other filesystems. and such other filesystems.
- Before you start building your Live Kit, please consider Before you start building your Live Kit, please consider
editing the ./.config file, and tweak it to suit your needs. editing the ./.config file, and tweak it to suit your needs.
Most importantly, change the LIVEKITNAME variable. Most importantly, change the LIVEKITNAME variable.
- Make sure you are pointing to the right kernel. If in doubt, Make sure you are pointing to the right kernel. If in doubt,
change the path in ./.config. Your kernel must support both change the path in ./.config. Your kernel must support both
SquashFS and AUFS, or else you will get an error both while SquashFS and AUFS, or else you will get an error both while
building, and when you actually boot your Live Kit. building, and when you actually boot your Live Kit.
### PROTIP: ### PROTIP:
* On most Linux distros, the kernel is in /vmlinuz, a * On most Linux distros, the kernel is in /vmlinuz, a
symlink to /boot/vmlinuz-* or even /boot/vmlinux-* symlink to /boot/vmlinuz-* or even /boot/vmlinux-*
@ -37,35 +37,35 @@ the original Linux Live Kit. <http://linux-live.org>
* Debian Jessie's kernel supports both AUFS and SquashFS out-of-the-box. * Debian Jessie's kernel supports both AUFS and SquashFS out-of-the-box.
It's recommended to use Debian Jessie as the base OS, but the choice is yours. It's recommended to use Debian Jessie as the base OS, but the choice is yours.
- It's recommended to replace boot background in It's recommended to replace boot background in
bootfiles/bootpic.png and edit syslinux.cfg to fit your needs. bootfiles/bootpic.png and edit syslinux.cfg to fit your needs.
### NOTE: ### NOTE:
* When editing the configuration file, make sure to keep all paths * When editing the configuration file, make sure to keep all paths
pointing to /boot/, since it will be replaced to /LIVEKITNAME/boot/ pointing to /boot/, since it will be replaced to /LIVEKITNAME/boot/
during the build session. during the build session.
- Linux Live Kit comes with precompiled static binaries in ./initramfs Linux Live Kit comes with precompiled static binaries in ./initramfs
directory. Those may be outdated but will work. You may replace them directory. Those may be outdated but will work. You may replace them
by your own statically linked binaries, if you know how to compile them. by your own statically linked binaries, if you know how to compile them.
- If you want to boot your Live Kit from a CD, you'll need to recompile If you want to boot your Live Kit from a CD, you'll need to recompile
syslinux.bin and/or isolinux.bin else it won't be able to boot syslinux.bin and/or isolinux.bin else it won't be able to boot
your Live Kit from directory "/LIVEKITNAME". your Live Kit from directory "/LIVEKITNAME".
There is a script prepared for you which will do all of the building. There is a script prepared for you which will do all of the building.
Simply go to directory ./tools/ and run isolinux.bin-update, it will rebuild Simply go to directory ./tools/ and run isolinux.bin-update, it will rebuild
isolinux.bin automatically by downloading SysLinux sources, patching them using isolinux.bin automatically by downloading SysLinux sources, patching them using
your actual LIVEKITNAME and recompiling. This step is not needed if you only need your actual LIVEKITNAME and recompiling. This step is not needed if you only need
the ZIP archive version. the ZIP archive version.
- If you have tmpfs mounted on /tmp, make sure you have enough (or maybe even If you have tmpfs mounted on /tmp, make sure you have enough (or maybe even
a lot of) RAM, since Live Kit will store lots of data to the target. a lot of) RAM, since Live Kit will store lots of data to the target.
If you don't have enough (or even went out of) RAM, make sure If you don't have enough (or even went out of) RAM, make sure
that /tmp is a regular on-disk directory. that /tmp is a regular on-disk directory.
- If you want to include your own bundules, then the 'include\_bund/' directory If you want to include your own bundules, then the 'include\_bund/' directory
might come in handy! Just make sure that the file extension will match might come in handy! Just make sure that the file extension will match
with your chosen .BEXT extension. with your chosen .BEXT extension.
When you're ready, run the ./build script to build your Live Kit Distro. When you're ready, run the ./build script to build your Live Kit Distro.
The script will: The script will: