commit 952c28a6c358d67464d195adf00ab975486f70c5 parent 9a4b022b111fa2a3e77a482c1eb5a4747dbcdcd4 Author: Vincent Forest <vincent.forest@meso-star.com> Date: Wed, 20 Oct 2021 10:19:40 +0200 Schiff: Add a "build from sources" overview section Diffstat:
| M | schiff/schiff.html.in | | | 52 | ++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 52 insertions(+), 0 deletions(-)
diff --git a/schiff/schiff.html.in b/schiff/schiff.html.in @@ -91,6 +91,58 @@ $ man schiff-geometry $ man schiff-output </pre> +<h2 id=build>Build from sources</h2> + +<p>Schiff can be built directly from its source tree. The simplest way to do +this is to rely on the <code>schiff</code> branch of the <a +href="https://gitlab.com/meso-star/star-engine/tree/schiff">Star-Engine</a> +project: it provides CMake scripts that automate the download, the compilation +and the installation of Schiff and its dependencies. This build procedure +assumes the following prerequisites:</p> + +<ul> + <li><a href=https://git-scm.com>git</a> source control.</li> + <li><a href=https://gcc.gnu.org>GNU Compiler Collection</a> in version 4.9.2 + or higher.</li> + <li><a href="https://cmake.org">CMake</a> in version 3.1 or higher.</li> +</ul> + +<h3>Build</h3> + +<p>Assuming that the aforementioned prerequisites are available, the build +procedure is summed up to:</p> + +<pre class="code"> +~ $ git clone -b Schiff-${VERSION} \ + https://gitlab.com/meso-star/star-engine.git Schiff-${VERSION} +~ $ mkdir Schiff-${VERSION}/build; cd Schiff-${VERSION}/build +~/Schiff-${VERSION}/build $ cmake ../cmake +~/Schiff-${VERSION}/build $ make +</pre> + +<h3>Run</h3> + +<p>By default Schiff is installed in the <code>local</code> subdirectory of +<code>Schiff-${VERSION}</code>. Source the provided <code>schiff.profile</code> +file to register Schiff against the current shell.</p> + +<pre class="code"> +$ source ~/Schiff-${VERSION}/local/etc/schiff.profile +$ schiff -h +</pre> + +<h3>Package</h3> + +<p>Once built, the Schiff installation can be packaged in an archive that can +then be deployed on compatible systems, <i>i.e.</i> systems whose C library is +compatible with the one available on the system used to build Schiff.</p> + +<pre class="code"> +~/Schiff-${VERSION}/build $ make pkg +~/Schiff-${VERSION}/build $ ls package/Schiff-${VERSION}* # list packages +</pre> + + <h2>Post-Process</h2> <p>The following Bash script illustrates how to post-process the Schiff