no_comment

1 files changed, 93 insertions, 0 deletions

diff --git a/docs/README b/docs/README
new file mode 100644
index 000000000..dd4d561a8
--- /dev/null
+++ b/docs/README
@@ -0,0 +1,93 @@
+Well here is a little description of what panoramix needs to work in comparison
+to the standard newt install.
+
+********************************************************************************
+* FILES ************************************************************************
+********************************************************************************
+First he are the different things needed :
+
+Mandrake/base/hdlist
+	table of rpm's headers. 
+	! Need to be remade when Mandrake/RPMS changes !
+
+Mandrake/base/depslist
+	for each packages, tell which package it depends on. Also contains the
+	size for some (obscure) bloody reasons.
+	! Need to be remade when Mandrake/RPMS changes !
+
+Mandrake/base/compss
+	obsoletes comps. It store packages in different categories, a bit like
+	the %{GROUP} field
+
+Mandrake/base/compssList
+	for each packages, it gives the appreciation for each type of user.
+	used to preselect packages
+	used to decide to show or hide packages.
+
+Mandrake/mdkinst
+	live system used on certain installs. See ``Ramdisk or not'' below for
+	more.
+
+Mandrake/base/mdkinst_stage2.gz
+	for the ramdisk. 
+	live sytem in ext2 filesystem gzipped. See ``Ramdisk or not'' below for
+	more.
+
+images/gi_*.img
+	boot images to use with panoramix. Use:
+	- gi_hd for hard-disk install
+	- gi_cdrom for cdrom install
+	- gi_network for ftp/nfs install
+	- gi_pcmcia for pcmcia install (see ``PCMCIA install'' below for more)
+
+
+Some optional files :
+
+Mandrake/base/depslist.html
+	html formatted depslist
+
+********************************************************************************
+* po translation files *********************************************************
+********************************************************************************
+Panoramix uses .po files for its translation. A script takes the different
+strings out of the .pm files. It generates the panoramix.pot file which contains
+all the english strings to translate.
+To add a new language, you just have to add it to lang.pm (if it's not there
+already) and put the .po in the perl-install/po directory (see ``Ramdisk or
+not'' to know if you have to regenerate the mdkinst_stage2.gz)
+
+********************************************************************************
+* PCMCIA install ***************************************************************
+********************************************************************************
+If the media you use to install is a pcmcia device, you have two choices:
+- use the gi_pcmcia boot disk
+- use another boot disk and it will ask you a supplementary disk. Give it the
+gi_pcmcia disk.
+
+
+********************************************************************************
+* Ramdisk or not ***************************************************************
+********************************************************************************
+The panoramix install is much bigger than the newt one. So the ramdisk which was
+used is getting big, and costs a lot in memory 
+(eg: the mdkinst_stage2 is 14MB - 23/09/99)
+
+|       | newt    | panoramix
+|-------+---------+----------------------------------------------------------
+| nfs   | live    | live
+| ftp   | ramdisk | ramdisk
+| http  | ramdisk | not yet :(
+| hd    | ramdisk | live if Mandrake/mdkinst/usr/bin/runinstall2 is a link,
+|       |         |   ramdisk otherwise
+| cdrom | ramdisk | live if memory < 40MB, ramdisk otherwise
+
+When i say live, it means that the install1 stage will *mount* the
+Mandrake/mdkinst and use it that way.
+
+The ramdisk is used in place of the live in some cases. This ramdisk is filled
+with mdkinst_stage2.gz
+
+For cdrom install, the ramdisk is used to speed up things (access time is quite
+high on cdrom drives)
+
+For pcmcia, it depends on the type of install.