Commit 78b366b8 authored by Cédric Le Ninivin's avatar Cédric Le Ninivin

Updated documentation

parent 0a92b307
......@@ -8,7 +8,7 @@ Requirements
------------
- A computer
- Internet connection
- gcc, g++, make, patch, wget, python, chrpath, osc, devscripts
- gcc, g++, make, patch, wget, python, chrpath, osc, devscripts
- An account on OBS
Documentation
......@@ -20,12 +20,11 @@ Documentation
Directory Organisation
----------------------
- prepare_slapos_build.sh : This is the script you have to run to prepare the packet.
- prepare_slapos_build.sh : This is the script you have to run to prepare the packet.
You can choose the version you want to build in it.
- ./home:VIFIBnexedi/SlapOS-Node : This is the directory for OBS. It is the one used to generate package so far.
If you have/want to use another directory, update its path in prepare_slapos_build.sh
- slapos-*version : Used to register current version of packet.
Avoid to rebuild network-cache if you just change packaging configuration files.
- ./home:VIFIBnexedi:branches:home:VIFIBnexedi/SlapOS-Node : This is the directory for OBS.
It is the one used to generate unreleased package and testing it.
If you have/want to use another directory, update its path in prepare_slapos_build.sh
- templates/ : Contain templates to build the package.
- debian/ : contain configuration files for .deb packaging
- Makefile.in : Makefile to build slapos
......@@ -33,10 +32,11 @@ Directory Organisation
- slapos.dsc.in : File needed by obs to build .deb package
- slapos.spec.in : configuration file for rpm packaging
- slapos-node/ : Template to build package
- Makefile : Makefile to build slapos and add files for package
- Makefile : Makefile to build slapos and add files for package
- slapos-start : shell script that will be run on startup (called by slapos-node daemon)
- template : template files for package (cron.d, service)
- slapos : to build slapos. Contain buildout.cfg.in
- slaptest : python script to check user configuration and cron file
- template/ : template files for package (cron.d, service)
- slapos/ : to build slapos. Contain buildout.cfg.in
preparing the package
......@@ -44,8 +44,11 @@ preparing the package
First make sure all files are ready and you have all necessary packages installed.
SlapOS is build using buildout and need an internet connection to fetch all elements.
On obs package are build on virtual machines without internet acces.
On obs package are build on virtual machines without internet access.
prepare_slapos_build.sh will compile slapos on your computer and build a network-cache thanks to offline.sh script.
At the end it remove slapos installation and only keep cache.
It makes a tarball out of it to be used by obs.
It then fetch packaging configuration from templates directory. Everything is then commit to obs thanks to osc.
\ No newline at end of file
It then fetch packaging configuration from templates directory. Everything is then commit to obs thanks to osc.
So to build package just run:
# bash prepare_slapos_build.sh
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment