kadischi/doc INSTALL,1.1.1.1,1.2 README,1.1.1.1,1.2
Darko Ilic (darko)
fedora-extras-commits at redhat.com
Tue Aug 23 15:57:40 UTC 2005
Author: darko
Update of /cvs/devel/kadischi/doc
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv16411/doc
Modified Files:
INSTALL README
Log Message:
Structure of README and INSTALL is changed.
Index: INSTALL
===================================================================
RCS file: /cvs/devel/kadischi/doc/INSTALL,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -u -r1.1.1.1 -r1.2
--- INSTALL 21 Aug 2005 17:08:47 -0000 1.1.1.1
+++ INSTALL 23 Aug 2005 15:57:38 -0000 1.2
@@ -1,32 +1,18 @@
-REQUIREMENTS
+THESE ARE BASIC INSTRUCTIONS.
-Following packages should be installed in order to run this application:
+IT IS STRONGLY RECOMMENDED TO CONSULT README FILE BEFORE PERFORMING THE
+INSTALLATION.
-anaconda
-busybox-anaconda
-syslinux
-mkisofs
-e2fsprogs
+*******************************************************
-INSTALLATION
+Go to the Kadischi source directory and type
-Go to the root directory of the source tree, and run './autogen.sh'. It will
-configure package for building. If you would like to pass some options to
-./configure, you can pass them to autogen.sh and it will forward them to
-./configure.
+./autogen
+make
+make install
-After that, you have to run 'make' in order to build the application.
-
-Run 'make install' to install the application (default location is
-/usr/share/kadischi for application files and /etc/kadischi for configuration
-files).
-
-Yet another thing you would have to do in order to run the application is to
-patch anaconda. Files that should be patched are /usr/sbin/anaconda and
-/usr/lib/anaconda/flags.py. Patches are in /usr/share/kadischi/patches dir, and
-are made against anaconda-10.2.1.5-2 (fc4 default).
-
-CONFIGURATION
+patch -b /usr/sbin/anaconda patches/anaconda.patch
+patch -b /usr/lib/anaconda/flags.py patches/flags.py.patch
Edit /etc/kadischi/build.conf and set BUILDDIR variable. BUILDDIR
is a directory that will be used for storing temporary files (temporary
@@ -37,8 +23,3 @@
You would also have to edit file /usr/lib/anaconda/product.py and to set
productPath (line 25) to "Fedora" (for Fedora repository).
-UNINSTALLATION
-
-Go to the root directory of the source tree and run 'make uninstall'. Make sure
-there are no extra files added to the application directories (for example
-/etc/kadischi/build.conf~).
\ No newline at end of file
Index: README
===================================================================
RCS file: /cvs/devel/kadischi/doc/README,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -u -r1.1.1.1 -r1.2
--- README 21 Aug 2005 17:08:47 -0000 1.1.1.1
+++ README 23 Aug 2005 15:57:38 -0000 1.2
@@ -1,36 +1,183 @@
-Kadischi 0.01
+1. About Kadischi
-Kadischi is fedora livecd generator tool.
+1.1 What is Kadischi
+1.2 How does Kadischi work
-This is _very_ early version of the application, and there are many things to be
-done until it gets ready for using. I will be _very_ thankful for all of your
-comments and suggestions.
+2. Installation
-ABOUT
+2.1 Requirements
+2.2 Downloading
+2.3 Installation
+2.4 Configuration
+2.5 Uninstallation
-Kadischi uses anaconda for system installation (system is installed in
-chroot env), and readonly-root stuff from stateless project is used as a
-starting point for building the livecd. /usr/share/kadischi/kadischi.py is the
-main script and it is used to glue all things together. It first prepares
-environment, then invokes anaconda. After anaconda finishes installation, scripts from /usr/share/kadischi/post_install_scripts directory are executed (path to system
-root is passed to them as an argument) in order to do all modifications to the
-system. That`s the place where system customization can be done - user can simply add
-his scripts here, and they will be executed. After all modifications are
-done, kadischi.py creates initrd image, then it compresses the whole
-tree (using zisofs) and finally, it creates iso image.
+3. Using Kadischi
-Since kadischi.py is quite simple, and well documented, it can be read
-very easily.
+3.1 Basic instructions
+3.2 Command line options
+3.3 Running Kadischi automatically
+3.4 Customizing Live CD system
+3.5 Bug reports
-We are going to need some config file options, and they will probably be
-stored in a new section of kickstart file (this have to be considered!).
+4. Under the bonnet
-RUNNING
+4.1 How does Kadischi work (in details)
+4.2 How does generated Live CD work
+4.3 Design notes
+4.4 Kadischi source tree
-kadischi /path/to/the/repository /path/to/the/image.iso
+A. Appendix
+
+A1. How to apply a patch
+A2. How to build a repository
+A3. Anaconda installation methods
+
+*******************************************************
+
+1. About Kadischi
+
+1.1 What is Kadischi
+
+Kadischi is an application for Fedora-based Live CD generation. It is still in
+the early stage of development, but has basic functionality and can be run
+successfully.
+
+1.2 How does Kadischi work
+
+Basically, Kadischi uses anaconda to install the system in a temporary directory
+(specified in the configuration file) on user`s hard drive. It then executes the
+collection of scripts (stored in /usr/share/kadischi/post_install_scripts) in
+order to modify the system to run successfully in read-only environment (CD).
+After all modifications are done, Kadischi creates an initrd image, then
+compresses the system tree (actually, it creates a compressed copy, and then
+removes the original one), and finally creates iso image of the system.
+
+For more details on the process, see "Under the bonnet" section.
+
+-----------------------------------------------------------------------------
+
+2. Installation
+
+2.1 Requirements
+
+Following packages should be installed in order to run Kadischi:
+
+anaconda
+busybox-anaconda
+syslinux
+mkisofs
+e2fsprogs
+
+2.2 Downloading
+
+For now, the only way to download Kadischi is via anonymous CVS.
+
+To do that, execute the following in a terminal (type enter when prompted for
+password):
+
++--------------------------------------------------------------------------------------------+
+| export CVSROOT=:pserver:anonymous at cvs.fedora.redhat.com:/cvs/devel |
+| cvs -z3 login |
+| cvs -z3 co kadischi |
++--------------------------------------------------------------------------------------------+
+
+If you don`t have cvs client installed on the machine, you can install it
+running
+
++--------------------------------------------------------------------------------------------+
+| yum install cvs |
++--------------------------------------------------------------------------------------------+
+
+2.3 Installation
+
+Go to the root directory of the source tree, and run './autogen.sh'. It will
+configure package for building. If you would like to pass some options to
+./configure, you can pass them to autogen.sh and it will forward them to
+./configure.
+
+After that, you have to run 'make' in order to build the application.
+
+Run 'make install' to install the application (default location is
+/usr/share/kadischi for application files and /etc/kadischi for configuration
+files).
+
+Yet another thing you would have to do in order to run the application is to
+patch anaconda. Files that should be patched are /usr/sbin/anaconda and
+/usr/lib/anaconda/flags.py. Patches are in /usr/share/kadischi/patches dir, and
+are made against anaconda-10.2.1.5-2 (fc4 default).
+
+2.4 Configuration
+
+Edit /etc/kadischi/build.conf and set BUILDDIR variable. BUILDDIR
+is a directory that will be used for storing temporary files (temporary
+installation will be performed in that directory). You will need
+approximately 1.5x size of desired installation available on that device. 3GB
+works fine for me.
+
+You would also have to edit file /usr/lib/anaconda/product.py and to set
+productPath (line 25) to "Fedora" (for Fedora repository).
+
+2.5 Uninstallation
+
+Go to the root directory of the source tree and run 'make uninstall'. Make sure
+there are no extra files added to the application directories (for example
+/etc/kadischi/build.conf~).
+
+-----------------------------------------------------------------------------
+
+3. Using Kadischi
+
+3.1 Basic instructions
+
+The basic way to run Kadischi is to type the following in a terminal
+
++---------------------------------------------------------------------------+
+| kadischi path-to-the-repository path-to-the-iso-image |
++---------------------------------------------------------------------------+
where path to the repository can be a path on the local file system, but can
-also be a path to ftp, http or some other type of repository. For details,
-see installation methods in anaconda.
+also be a path to ftp, http or some other type of repository.
+
+Example:
+
++---------------------------------------------------------------------------+
+| kadischi /tmp/fc4 /tmp/fedora-live.iso |
++---------------------------------------------------------------------------+
+
+where /tmp/fc4 is a directory holding a Fedora repository. For instructions on
+creating a local repository, colsult "How to build a repository" section from
+Appendix.
+
+Example 2:
+
++----------------------------------------------------------------------------------------------------------------------+
+| kadischi http://download.fedora.redhat.com/pub/fedora/linux/core/4/i386/os /tmp/fedora-live.iso |
++----------------------------------------------------------------------------------------------------------------------+
+
+for installing from http repository. For details on available installation
+methods, consult "Anaconda installation methods" in Appendix.
+
+3.2 Command line options
+
+Type 'kadischi --help' for list of Kadischi command line options.
+
+3.3 Running Kadischi automatically
+3.4 Customizing Live CD system
+3.5 Bug reports
+
+-----------------------------------------------------------------------------
+
+4. Under the bonnet
+
+4.1 How does Kadischi work (in details)
+4.2 How does generated Live CD work
+4.3 Design notes
+4.4 Kadischi source tree
+
+-----------------------------------------------------------------------------
+
+A. Appendix
-Type 'kadischi --help' for list of kadischi command line options.
\ No newline at end of file
+A1. How to apply a patch
+A2. How to build a repository
+A3. Anaconda installation methods
\ No newline at end of file
More information about the fedora-extras-commits
mailing list