diff options
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | doc/DEPENDENCIES-BUILD.md (renamed from documentation/DEPENDENCIES-BUILD.md) | 0 | ||||
| -rw-r--r-- | doc/INTERNALS.md (renamed from documentation/INTERNALS.md) | 0 | ||||
| -rw-r--r-- | doc/index.html | 92 |
4 files changed, 93 insertions, 1 deletions
@@ -173,7 +173,7 @@ This means the toolchain from your BUILD to your TARGET, even if BUILD and TARGET are the same. HOST_HOST_BASE is the path where your native toolchain for the TARGET -is installed. TODO: rename this variable +is installed. COUNTRY_CODE, LOCAL_IP and ROUTER_IP are configuration variables for your TARGET. COUNTRY_CODE is one of `uk`, `fr`, `rs`, `vn` or `cn`. diff --git a/documentation/DEPENDENCIES-BUILD.md b/doc/DEPENDENCIES-BUILD.md index e1d97de..e1d97de 100644 --- a/documentation/DEPENDENCIES-BUILD.md +++ b/doc/DEPENDENCIES-BUILD.md diff --git a/documentation/INTERNALS.md b/doc/INTERNALS.md index ab7aa54..ab7aa54 100644 --- a/documentation/INTERNALS.md +++ b/doc/INTERNALS.md diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000..d17ff15 --- /dev/null +++ b/doc/index.html @@ -0,0 +1,92 @@ +<html> + <head> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <meta http-equiv="Content-Language" content="en" /> + <title>lh-bootstrap - a tool to build images running s6 and s6-rc</title> + <meta name="Description" content="lh-bootstrap - a tool to build images running s6 and s6-rc" /> + <meta name="Keywords" content="lh-bootstrap bootstrap VM qemu linux s6 s6-rc virtual machine disk image" /> + <!-- <link rel="stylesheet" type="text/css" href="http://skarnet.org/default.css" /> --> + </head> +<body> + +<p> +<a href="http://skarnet.org/software/">Software</a><br /> +<a href="http://skarnet.org/">skarnet.org</a> +</p> + +<h1> lh-bootstrap </h1> + +<h2> What is it ? </h2> + +<p> + <tt>lh-bootstrap</tt> is a set of scripts that build a disk image +for a virtual machine such as <a href="http://www.qemu.org/">QEMU</a>. +The image uses <a href="https://kernel.org/">Linux</a>, +<a href="http://musl-libc.org/">musl</a>, +<a href="http://busybox.net/">BusyBox</a>, and skarnet.org tools, +and similar small and efficient software. It provides the necessary +minimum amount of tools to securely connect to the Internet and +download more software while having a stable init system and service +infrastructure. +</p> + +<hr /> + +<h2> Installation </h2> + +<h3> Requirements </h3> + +<p> + Read the +<a href="https://github.com/skarnet/lh-bootstrap/blob/master/README.md">README.md</a> +file (on GitHub, for Markdown formatting). +</p> + +<h3> Licensing </h3> + +<p> + lh-bootstrap is free software. It is available under the +<a href="https://opensource.org/licenses/GPL-2.0">GNU General Public License +version 2</a>. +</p> + +<h3> Download </h3> + +<p> +<tt>lh-bootstrap</tt> does not have regular numbered releases; you should always +pull the latest version from Git. +</p> + +<ul> + <li> Pull from the +<a href="http://git.skarnet.org/cgi-bin/cgit.cgi/lh-bootstrap/">main +lh-bootstrap git repository</a>: +<pre> git clone git://git.skarnet.org/lh-bootstrap </pre> </li> + <li> Pull from the +<a href="https://github.com/skarnet/lh-bootstrap">GitHub mirror</a>. </li> +</ul> + +<h3> Compilation </h3> + +<ul> + <li> Read the <a href="https://github.com/skarnet/lh-bootstrap/blob/master/README.md">README.md</a> +file carefully </li> + <li> Copy <tt>lh-config.dist</tt> to <tt>lh-config</tt> and edit it to suit your needs </li> + <li> Run <tt>./make</tt> </li> +</ul> + +<a name="related"> +<h2> Related resources </h2> +</a> + +<h3> lh-bootstrap discussion </h3> + +<ul> + <li> <tt>lh-bootstrap</tt> is discussed on the +<a href="http://skarnet.org/lists.html#skaware">skaware</a> mailing-list. </li> + <li> It can also be discussed on the <tt>#s6</tt> IRC channel on Freenode. </li> +</ul> + +</body> +</html> |