changes to the readme by Greg Frost

1 files changed, 89 insertions, 47 deletions

diff --git a/README b/README
index 9ebaa04..05aa94f 100644
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-The LinHES development  is divided into two different git repositories.
+    The LinHES development  is divided into two different git repositories.
 The first repository is LinHES-PKGBUILD, and it contains all the PKGBUILD
 files that make up LinHES.  The second repository is called LinHES-dev and is
 intended to create a chroot for all development to occur within.  By using a
@@ -6,9 +6,9 @@ chroot development work can be done on non-LinHES machines.  The reason for
 the split is so that the PKGBUILD's may be downloaded and modified by
 non-developers without requiring them to download the entire development
 environment.
-
+ 
 ------ LinHES-PKGBUILD -----------
-
+ 
 The layout of the LinHES-PKGBUILD repository is as follows.
 -- abs
     |-- chroot-devel  
@@ -17,22 +17,22 @@ The layout of the LinHES-PKGBUILD repository is as follows.
     |-- core-testing
     |-- extra
     |-- extra-testing
-
+ 
 Core is the  set of packages that make up the "core" of LinHES, or in other
 words all the packages needed to create a fully functioning system.
-
+ 
 Extra contains all the packages used by LinHES, but not necessarily needed
 to create a fully functioning system.  For example this would include
 mplayer, xine and mozilla.  
-
+ 
 Chroot-devel are packages used by developers that are not in LinHES.
-
+ 
 The difference between core and core-testing is that core is intended to be
 used for public iso releases, where as core-testing is intended for developers
 or beta testing.  The same applies to extra and chroot-devel.
-
+ 
 -----------  LinHES-dev -------------------
-
+ 
      LinHES-dev  contains the tools and scripts  for a  working development
 environment, but it is not a working development by itself.  The script
 setup-env.sh will do all the work in creating a working development
@@ -46,7 +46,7 @@ For example running "setup-env.sh i686" will create a working i686 LinHES
 development environment named build_root.i686.  Setup-env.sh also creates an
 empty directory structure called pkg_repo, this is used by kmsync.sh
 (which will be discussed later).
-
+ 
      To enter the build root run  (as root) the newly created script called
 enter_build_root.i686.  The script will take care of the following things:
         a) mounting proc,sys,dev/pts
@@ -54,28 +54,28 @@ enter_build_root.i686.  The script will take care of the following things:
         c) bind mounting LinHES-PKGBUILD to build_root/data/LinHES-PKGBUILD
         d) bind mounting pkg_repo to build_root/data/pkg_repo.
         e) unmount the above directories  when leaving the chroot
-
+ 
 The following is a list of tools available to you inside the chroot.
-
+ 
 a) mp
         Small script to compile a package, copy it to the local testing repo
         and update the local database using the repo-add function. Must
         be called from the same directory that contains the PKGBUILD.
         This script takes all the same arguments that makepkg takes.
-
+ 
 b) mpr | mpl
         mpr)  Symlink to mp that does the same thing as mp except it copies the
             package to the release repo
-
+ 
         mpr)  Symlink to mp that does the same thing as mp except it copies the
               package to a local repo
-
+ 
 c) update_db_repo 
         Used to completely regenerate the the local package database.
         Takes two arguments  the directory with packages, and the name of
         the repository.  Example:
         update_db_repo  /data/pkg_repo/i686/core-testing core-testing
-
+ 
 d)  kmsync.sh (testing|release|chroot-devel|source[testing|release|chroot-devel]
         This script is used to synchronize the contents of the compiled
         packages on knoppmyth.net and the ones on your local machine. 
@@ -88,12 +88,12 @@ d)  kmsync.sh (testing|release|chroot-devel|source[testing|release|chroot-devel]
         This includes the possibility to completely erase all the packages.
         Normally the source packages are synced when the binary packages are synced.  The 
         source option is present to force an update, and isn't not normally required to be run.
-
+ 
         Finally this script uses a shared user account on knoppmyth.net that
         is a locked account.  SSH  keys must be setup for this script to work.
-
-
-
+ 
+ 
+ 
 e) build_tools/go.sh
         Menu driven fronted to create an ISO with selected profile
         The following profiles are available to create an iso.
@@ -106,41 +106,82 @@ e) build_tools/go.sh
     d ) i686-testing-local-httpdir-structure
         Create an ISO from the testing repo using packages from a local web
         server name "localmirror"
-
+ 
         After the process finishes it will let you know the final name and
 location of the resulting ISO.  For any of the local profiles to work, it
 requires that kmsync be run at least once to populate the local mirror.
-
+ 
 Quick start showing typical process to create the chroot and build an ISO.
 ############
 Create the chroot for i686
-
-First checkout the repo
-
+ 
+If you are using an R6 install as your dev box, you will need to install git. 
+Make sure you have the following entries in /etc/pacman.conf:
+ 
+[core-testing]
+Server = http://knoppmyth.net/repo/i686/core-testing
+ 
+[extra-testing]
+Server = http://knoppmyth.net/repo/i686/extra-testing
+ 
+[chroot-devel]
+Server = http://knoppmyth.net/repo/i686/chroot-devel
+ 
+Then run:
+        pacman -Syu
+        pacman -S git
+ 
+Then checkout the repo. You will need to have been given a dev account on 
+knoppmyth.net. This involves creating a public ssh key and supplying it to
+one of the knoppmyth.net admins. The key is created using ssh-keygen. The 
+resulting public key will be stored in .ssh/id_rsa.pub.
+ 
+The recommended location for the checkout is /myth/dev.
+        cd /myth/dev
+ 
 - Restricted dev accounts should use
- 	git clone $USER@knoppmyth.net:LinHES-PKGBUILD   
- 	git clone $USER@knoppmyth.net:LinHES-dev
-
+        git clone $USER@knoppmyth.net:LinHES-PKGBUILD   
+        git clone $USER@knoppmyth.net:LinHES-dev
+ 
 - Unresticted dev account should use
-	git clone ssh://$USER@knoppmyth.net/mount/repository/LinHES-dev
-	git clone ssh://$USER@knoppmyth.net/mount/repository/LinHES-PKGBUILD
-
+        git clone ssh://$USER@knoppmyth.net/mount/repository/LinHES-dev
+        git clone ssh://$USER@knoppmyth.net/mount/repository/LinHES-PKGBUILD
+ 
+- Edit LinHES-dev/templates/pacman.conf.chroot. Comment out the core and 
+extra lines and uncomment the core-testing and extra-testing.
+ 
 - Run these commands:
-  	cd LinHES-dev/
-	sudo ./setup_env.sh i686
-	cd ..
-	sudo ./enter_dev_chroot.i686
-
-Build and iso from knoppmyth.net 
-cdb <= alias
-./go.sh
- (select i686-testing-REMOTE)
-
+        cd LinHES-dev/
+        sudo ./setup_env.sh i686
+        cd ..
+ 
+- Setup the shh keys inside the build root. If the ssh public key you 
+provided to the knoppmyth.net admin was created by root on an r6 install:
+        cp -R /root/.ssh build_root.i686/root/.ssh
+ 
+- Then to enter the chroot
+        sudo ./enter_dev_chroot.i686
+ 
+-- To Build an ISO from knoppmyth.net:
+        cdb <= alias
+        ./go.sh
+         (select i686-testing-REMOTE)
+ 
+-- To build an ISO locally:
+Before running kmsync.sh for the first time, for reasons explained above, 
+ensure the local directories (/data/pkg_repo/i686/core|extra|chroot-devel) 
+are empty. Then run:
+ 
+        kmsync.sh testing
+        ./go.sh
+          (Select i686-testing-local)
+ 
 #---------
 Commands used to build a package (tar in this example), and update knoppmyth.net
-Before building ANY packages you __MUST__ run "kmsync.sh testing" at least once while the local package directories are still empty.
-Doing this step now will avoid sync headaches down the road.
-
+Before building ANY packages you __MUST__ run "kmsync.sh testing" at least once 
+while the local package directories are still empty. Doing this step now will avoid 
+sync headaches down the road.
+ 
 cdl  <= alias that takes you the the top level  PKGBUILD directory
 cd core-testing
 cd tar
@@ -149,8 +190,9 @@ mp
 # at this point you should test the package, either by building
 # a new iso or installing the package)
 kmsync.sh testing  <= this will pull down all new packages from knoppmyth.net
-                                    and upload the new tar package.  This will also sync up the src packages.
-
+                      and upload the new tar package. This will also sync up 
+                            the src packages.
+ 
 -----------------------
 Misc.
 Directory structure after a functioning chroot is created for i686
@@ -159,6 +201,6 @@ Directory structure after a functioning chroot is created for i686
 |-- build_root.i686
 |-- enter_dev_chroot.i686.sh
 `-- pkg_repo
-
+ 
 -----------------------
 # End