aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristos.K <freedomrfox@gmail.com>2017-08-28 19:57:32 +0300
committerChristos.K <freedomrfox@gmail.com>2017-08-28 19:57:32 +0300
commit6610367fc0a59091d65091000cf9c9fdd4862ea0 (patch)
treefc082085ee8c23233c9a26be798baad3f185b29f
parentUpdated Readme (diff)
downloadGSE-6610367fc0a59091d65091000cf9c9fdd4862ea0.tar.gz
GSE-6610367fc0a59091d65091000cf9c9fdd4862ea0.tar.bz2
GSE-6610367fc0a59091d65091000cf9c9fdd4862ea0.zip
Included a guide, not completed yet
-rw-r--r--Guide15
1 files changed, 15 insertions, 0 deletions
diff --git a/Guide b/Guide
new file mode 100644
index 0000000..82a14f8
--- /dev/null
+++ b/Guide
@@ -0,0 +1,15 @@
+# Guide for System Builder
+The system builder is consisted from a number of scripts that take atvantage of Gentoo features to build a system that is prepared for stateless boot and function.
+
+To read more about the project, read the gse.5 under docs directory
+To build a system, run:
+ - cd /path/to/"gse git dir"i/bin
+ 1) ./gse --base=base_arg --option1 --option2 --option3
+ To read more about command line options from gse.1 under docs directory
+ 2) ./gse
+ This option, without any cmdline arguments will bring up the gse text menu for a guide
+
+Whatever the method of build is, at the end you will end up with a stage3 tarball under dist.d inside the project's directory.
+
+TBU
+