Changed documentation to accommodate Meson.

nathangeffen · Nov 21, 2019 · 91ac43e · 91ac43e
1 parent 9ed4744
commit 91ac43e
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 82 deletions.
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/installation.doctree b/docs/_build/doctrees/installation.doctree
diff --git a/docs/_build/html/_sources/installation.rst.txt b/docs/_build/html/_sources/installation.rst.txt
@@ -17,7 +17,7 @@ Library <https://www.gnu.org/software/gsl/>`_ and `Gnome's Glib utility library
 
 On Ubuntu, Debian, Mint etc. this should do the trick: ::
 
-  sudo apt install build-essential libgsl-dev libglib2.0-dev
+  sudo apt install build-essential libgsl-dev libglib2.0-dev meson
 
 
 2. Download |PROJECT| from |DOWNLOAD| and decompress
@@ -39,7 +39,7 @@ Mac
 
 2. Using `Homebrew <https://brew.sh/>`_ install the dependencies: ::
 
-     brew install gcc pkg-config glib gsl
+     brew install gcc pkg-config glib gsl meson
 
 This should create a directory called |DIRNAME| which contains the |PROJECT| files.
 
@@ -60,7 +60,7 @@ Cygwin
 
 - gcc-core
 - make
-- automake
+- meson
 - libgsl-dev
 - libglib2.0-devel
 - wget
@@ -81,45 +81,33 @@ On all machines
 3. Change into the directory that you've decompressed the distribution
 into: |DIRNAME|
 
-4. Now run: ::
+4. Now use the meson build system: ::
 
-     ./configure
-     make -j
+     meson --buildtype release release
+     cd release
+     ninja
 
 5. Then depending on your system either one of these should install the files: ::
 
-     sudo make install
+     sudo ninja install
 
 Or::
 
-     make install
+     ninja install
 
 6. Now test that it works: ::
 
-     FSTI_DATA=./data faststi -t
+     FSTI_DATA=../data faststi -t
 
 This will run the test suite. If everything is properly installed then no
 failures should be reported.
 
 .. note:: You may be wondering why we prefix the executable with
-          *FSTI_DATA=./data*. The *FSTI_DATA* environment variable simply tells
-          |PROJECT| where the data files are stored. As you work on |PROJECT| you
-          may use a different directory for your data files. It's simply that
-          the default data files are in the *data* directory.
+          *FSTI_DATA=../data*. The *FSTI_DATA* environment variable simply tells
+          |PROJECT| where the data files are stored. As you work on |PROJECT|
+          you may use a different directory for your data files. It's simply
+          that the default data files are in the *data* directory.
 
-|PROJECT| uses `GNU autotools
-<https://www.gnu.org/software/automake/manual/html_node/index.html>`_ to compile
-which is the standard on POSIX (Linux, Unix etc) systems. The standard autotools
-commands work with |PROJECT|.
+To uninstall |PROJECT| simply go into the release directory and run: ::
 
-Incidentally, compiling like this might make |PROJECT| a bit faster: ::
-
-  make clean
-  make "CFLAGS=-DNDEBUG -O3"
-  sudo make install
-
-But results may vary.
-
-To uninstall |PROJECT| simply run: ::
-
-  sudo make uninstall
+  sudo ninja uninstall
diff --git a/docs/_build/html/installation.html b/docs/_build/html/installation.html
@@ -185,7 +185,7 @@ <h2>Linux etc.<a class="headerlink" href="#linux-etc" title="Permalink to this h
 <p>1. FastSTI requires a standard C development environment, the <a class="reference external" href="https://www.gnu.org/software/gsl/">GNU Scientific
 Library</a> and <a class="reference external" href="https://developer.gnome.org/glib/">Gnome’s Glib utility library</a>.</p>
 <p>On Ubuntu, Debian, Mint etc. this should do the trick:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span> <span class="n">install</span> <span class="n">build</span><span class="o">-</span><span class="n">essential</span> <span class="n">libgsl</span><span class="o">-</span><span class="n">dev</span> <span class="n">libglib2</span><span class="o">.</span><span class="mi">0</span><span class="o">-</span><span class="n">dev</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span> <span class="n">install</span> <span class="n">build</span><span class="o">-</span><span class="n">essential</span> <span class="n">libgsl</span><span class="o">-</span><span class="n">dev</span> <span class="n">libglib2</span><span class="o">.</span><span class="mi">0</span><span class="o">-</span><span class="n">dev</span> <span class="n">meson</span>
 </pre></div>
 </div>
 <p>2. Download FastSTI from <a class="reference external" href="https://www.simhub.online/media/dist/faststi/faststi-0.2.2.tar.gz">https://www.simhub.online/media/dist/faststi/faststi-0.2.2.tar.gz</a> and decompress
@@ -202,7 +202,7 @@ <h2>Mac<a class="headerlink" href="#mac" title="Permalink to this headline">¶</
 <ol class="arabic">
 <li><p>Download and decompress this file: <a class="reference external" href="https://www.simhub.online/media/dist/faststi/latest.tar.gz">https://www.simhub.online/media/dist/faststi/latest.tar.gz</a></p></li>
 <li><p>Using <a class="reference external" href="https://brew.sh/">Homebrew</a> install the dependencies:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">brew</span> <span class="n">install</span> <span class="n">gcc</span> <span class="n">pkg</span><span class="o">-</span><span class="n">config</span> <span class="n">glib</span> <span class="n">gsl</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">brew</span> <span class="n">install</span> <span class="n">gcc</span> <span class="n">pkg</span><span class="o">-</span><span class="n">config</span> <span class="n">glib</span> <span class="n">gsl</span> <span class="n">meson</span>
 </pre></div>
 </div>
 </li>
@@ -223,7 +223,7 @@ <h3>Cygwin<a class="headerlink" href="#cygwin" title="Permalink to this headline
 <ul class="simple">
 <li><p>gcc-core</p></li>
 <li><p>make</p></li>
-<li><p>automake</p></li>
+<li><p>meson</p></li>
 <li><p>libgsl-dev</p></li>
 <li><p>libglib2.0-devel</p></li>
 <li><p>wget</p></li>
@@ -245,25 +245,26 @@ <h2>On all machines<a class="headerlink" href="#on-all-machines" title="Permalin
 <p>3. Change into the directory that you’ve decompressed the distribution
 into: faststi-0.2.2</p>
 <ol class="arabic" start="4">
-<li><p>Now run:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">configure</span>
-<span class="n">make</span> <span class="o">-</span><span class="n">j</span>
+<li><p>Now use the meson build system:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">meson</span> <span class="o">--</span><span class="n">buildtype</span> <span class="n">release</span> <span class="n">release</span>
+<span class="n">cd</span> <span class="n">release</span>
+<span class="n">ninja</span>
 </pre></div>
 </div>
 </li>
 <li><p>Then depending on your system either one of these should install the files:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">make</span> <span class="n">install</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">ninja</span> <span class="n">install</span>
 </pre></div>
 </div>
 </li>
 </ol>
 <p>Or:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">install</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ninja</span> <span class="n">install</span>
 </pre></div>
 </div>
 <ol class="arabic" start="6">
 <li><p>Now test that it works:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">FSTI_DATA</span><span class="o">=./</span><span class="n">data</span> <span class="n">faststi</span> <span class="o">-</span><span class="n">t</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">FSTI_DATA</span><span class="o">=../</span><span class="n">data</span> <span class="n">faststi</span> <span class="o">-</span><span class="n">t</span>
 </pre></div>
 </div>
 </li>
@@ -273,23 +274,13 @@ <h2>On all machines<a class="headerlink" href="#on-all-machines" title="Permalin
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>You may be wondering why we prefix the executable with
-<em>FSTI_DATA=./data</em>. The <em>FSTI_DATA</em> environment variable simply tells
-FastSTI where the data files are stored. As you work on FastSTI you
-may use a different directory for your data files. It’s simply that
-the default data files are in the <em>data</em> directory.</p>
+<em>FSTI_DATA=../data</em>. The <em>FSTI_DATA</em> environment variable simply tells
+FastSTI where the data files are stored. As you work on FastSTI
+you may use a different directory for your data files. It’s simply
+that the default data files are in the <em>data</em> directory.</p>
 </div>
-<p>FastSTI uses <a class="reference external" href="https://www.gnu.org/software/automake/manual/html_node/index.html">GNU autotools</a> to compile
-which is the standard on POSIX (Linux, Unix etc) systems. The standard autotools
-commands work with FastSTI.</p>
-<p>Incidentally, compiling like this might make FastSTI a bit faster:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">clean</span>
-<span class="n">make</span> <span class="s2">&quot;CFLAGS=-DNDEBUG -O3&quot;</span>
-<span class="n">sudo</span> <span class="n">make</span> <span class="n">install</span>
-</pre></div>
-</div>
-<p>But results may vary.</p>
-<p>To uninstall FastSTI simply run:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">make</span> <span class="n">uninstall</span>
+<p>To uninstall FastSTI simply go into the release directory and run:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">ninja</span> <span class="n">uninstall</span>
 </pre></div>
 </div>
 </div>

diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -17,7 +17,7 @@ Library <https://www.gnu.org/software/gsl/>`_ and `Gnome's Glib utility library
 
 On Ubuntu, Debian, Mint etc. this should do the trick: ::
 
-  sudo apt install build-essential libgsl-dev libglib2.0-dev
+  sudo apt install build-essential libgsl-dev libglib2.0-dev meson
 
 
 2. Download |PROJECT| from |DOWNLOAD| and decompress
@@ -39,7 +39,7 @@ Mac
 
 2. Using `Homebrew <https://brew.sh/>`_ install the dependencies: ::
 
-     brew install gcc pkg-config glib gsl
+     brew install gcc pkg-config glib gsl meson
 
 This should create a directory called |DIRNAME| which contains the |PROJECT| files.
 
@@ -60,7 +60,7 @@ Cygwin
 
 - gcc-core
 - make
-- automake
+- meson
 - libgsl-dev
 - libglib2.0-devel
 - wget
@@ -81,45 +81,33 @@ On all machines
 3. Change into the directory that you've decompressed the distribution
 into: |DIRNAME|
 
-4. Now run: ::
+4. Now use the meson build system: ::
 
-     ./configure
-     make -j
+     meson --buildtype release release
+     cd release
+     ninja
 
 5. Then depending on your system either one of these should install the files: ::
 
-     sudo make install
+     sudo ninja install
 
 Or::
 
-     make install
+     ninja install
 
 6. Now test that it works: ::
 
-     FSTI_DATA=./data faststi -t
+     FSTI_DATA=../data faststi -t
 
 This will run the test suite. If everything is properly installed then no
 failures should be reported.
 
 .. note:: You may be wondering why we prefix the executable with
-          *FSTI_DATA=./data*. The *FSTI_DATA* environment variable simply tells
-          |PROJECT| where the data files are stored. As you work on |PROJECT| you
-          may use a different directory for your data files. It's simply that
-          the default data files are in the *data* directory.
+          *FSTI_DATA=../data*. The *FSTI_DATA* environment variable simply tells
+          |PROJECT| where the data files are stored. As you work on |PROJECT|
+          you may use a different directory for your data files. It's simply
+          that the default data files are in the *data* directory.
 
-|PROJECT| uses `GNU autotools
-<https://www.gnu.org/software/automake/manual/html_node/index.html>`_ to compile
-which is the standard on POSIX (Linux, Unix etc) systems. The standard autotools
-commands work with |PROJECT|.
+To uninstall |PROJECT| simply go into the release directory and run: ::
 
-Incidentally, compiling like this might make |PROJECT| a bit faster: ::
-
-  make clean
-  make "CFLAGS=-DNDEBUG -O3"
-  sudo make install
-
-But results may vary.
-
-To uninstall |PROJECT| simply run: ::
-
-  sudo make uninstall
+  sudo ninja uninstall