From 1a7d8973f6623e340cdd98592a935a70f007548d Mon Sep 17 00:00:00 2001 From: johndah4x0r Date: Wed, 26 Jul 2017 13:36:37 +0200 Subject: [PATCH] Update README.md --- README.md | 62 +++++++++++++++++++++++++++---------------------------- 1 file changed, 31 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 13f0d5a..e143260 100644 --- a/README.md +++ b/README.md @@ -11,24 +11,24 @@ the original Linux Live Kit. ## Before you build: -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. -The best practice is to make a directory such -as for example: '/tmp/a', and put all the files there. +1. 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. + The best practice is to make a directory such + as for example: '/tmp/a', and put all the files there. ### NOTE: * Make sure to extract and use it on a POSIX-compatible filesystem (for ex: EXT4), since it will create symlinks and such that might not be compatible in for example: FAT and such other filesystems. -Before you start building your Live Kit, please consider -editing the ./.config file, and tweak it to suit your needs. -Most importantly, change the LIVEKITNAME variable. +2. Before you start building your Live Kit, please consider + editing the ./.config file, and tweak it to suit your needs. + Most importantly, change the LIVEKITNAME variable. -Make sure you are pointing to the right kernel. If in doubt, -change the path in ./.config. Your kernel must support both -SquashFS and AUFS, or else you will get an error both while -building, and when you actually boot your Live Kit. +3. Make sure you are pointing to the right kernel. If in doubt, + change the path in ./.config. Your kernel must support both + SquashFS and AUFS, or else you will get an error both while + building, and when you actually boot your Live Kit. ### PROTIP: * On most Linux distros, the kernel is in /vmlinuz, a symlink to /boot/vmlinuz-* or even /boot/vmlinux-* @@ -37,35 +37,35 @@ building, and when you actually boot your Live Kit. * 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 replace boot background in -bootfiles/bootpic.png and edit syslinux.cfg to fit your needs. +4. It's recommended to replace boot background in + bootfiles/bootpic.png and edit syslinux.cfg to fit your needs. ### NOTE: * When editing the configuration file, make sure to keep all paths pointing to /boot/, since it will be replaced to /LIVEKITNAME/boot/ during the build session. -Linux Live Kit comes with precompiled static binaries in ./initramfs -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. +5. Linux Live Kit comes with precompiled static binaries in ./initramfs + 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. -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 -your Live Kit from directory "/LIVEKITNAME". + 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 + your Live Kit from directory "/LIVEKITNAME". -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 -isolinux.bin automatically by downloading SysLinux sources, patching them using -your actual LIVEKITNAME and recompiling. This step is not needed if you only need -the ZIP archive version. + 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 + isolinux.bin automatically by downloading SysLinux sources, patching them using + your actual LIVEKITNAME and recompiling. This step is not needed if you only need + the ZIP archive version. -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. -If you don't have enough (or even went out of) RAM, make sure -that /tmp is a regular on-disk directory. +6. 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. + If you don't have enough (or even went out of) RAM, make sure + that /tmp is a regular on-disk 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 -with your chosen .BEXT extension. +7. 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 + with your chosen .BEXT extension. When you're ready, run the ./build script to build your Live Kit Distro. The script will: