summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorpgen <p.gen.progs@gmail.com>2015-11-22 11:49:44 +0100
committerpgen <p.gen.progs@gmail.com>2015-11-22 12:06:40 +0100
commitbf6615c1021aadc672ad35b77162944a8b6f24d6 (patch)
tree9efa65f00937f9b870d1f7425fb648f5def03539 /README.rst
parent08b5ef7ef446ed652f4512d6de02616251caedff (diff)
Improve the build.sh script and adjust the documentation
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst20
1 files changed, 9 insertions, 11 deletions
diff --git a/README.rst b/README.rst
index b71f4b2..605a4d9 100644
--- a/README.rst
+++ b/README.rst
@@ -18,18 +18,18 @@ How to build it?
development platform is available. This includes every Unix and Unix
like systems I am aware of.
-It can be easily compiled and installed with the usual ``configure``,
-``make``, ``make install`` commands. A simple script: ``build.sh`` is
-provided to automate this procedure.
+Please use the provided ``build.sh`` to build the executable. This
+script accepts the same arguments as ``configure``, type ``build.sh
+--help`` the see them.
-Use the included ``autogen.sh`` if you need to generate a new
-``configure`` script from ``configure.ac`` and ``Makefile.am``.
+The script ``autogen.sh`` is also provided if you need to generate a
+new ``configure`` script from ``configure.ac`` and ``Makefile.am``. The
+GNU **autotools** will need to be installed for this script to work.
How to install it?
==================
-For now, there is no installation procedure as all that is required to
-do is to put the resulting binary and man page in their traditional
-places.
+Once the build process has finished, a simple ``make install`` with the
+appropriate privileges will do it
Some examples.
==============
@@ -102,6 +102,4 @@ Note the presence of a scrollbar.
Interested?
-----------
-Please read the included man page to learn more about this little program.
-
-On Linux, ``man ./smenu.1`` will do it.
+Please use the included man page to learn more about this little program.