aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'docs/guides/Guide-Builder')
-rw-r--r--docs/guides/Guide-Builder16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/guides/Guide-Builder b/docs/guides/Guide-Builder
new file mode 100644
index 0000000..1fc1c7f
--- /dev/null
+++ b/docs/guides/Guide-Builder
@@ -0,0 +1,16 @@
+# 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 bin (it's under the projects git directory)
+ 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.
+
+The above image will be used by the initramfs functions (controller) to fetch it, extract, configure it and boot it at the end.
+