Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
fredrikwidlund committed May 17, 2020
1 parent eb2a13a commit e76983e
Showing 1 changed file with 25 additions and 33 deletions.
58 changes: 25 additions & 33 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
README
======
libdynamic v2.0
===============

.. image:: https://travis-ci.org/fredrikwidlund/libdynamic.svg?branch=master
:target: https://travis-ci.org/fredrikwidlund/libdynamic
Expand All @@ -16,51 +16,43 @@ README

Documentation is available at http://libdynamic.readthedocs.io/en/latest/.

Compiling and installing
========================
Description
===========

Status
======

Build
=====

Build from the Git repository
-------------------------

The source uses GNU Autotools (autoconf_, automake_, libtool_), so
compiling and installing is simple:
Building from Git requires GNU Autotools (autoconf_, automake_, libtool_).

.. code-block:: shell
$ ./autogen.sh
$ ./configure
$ make
$ make install
To run the test suite which requires cmocka_ and valgrind_, invoke:
Build from release
------------------

.. code-block:: shell
$ make check
To change the destination directory (``/usr/local`` by default), use
the ``--prefix=DIR`` argument to ``./configure``. See ``./configure
--help`` for the list of all possible configuration options.
$ ./configure
$ make install
The command ``make check`` runs the test suite distributed with
libdynamic. This step is not strictly necessary, but it may find possible
problems that libdynamic has on your platform. If any problems are found,
please report them.
Running unit tests
------------------

If you obtained the source from a Git repository (or any other source
control system), there's no ``./configure`` script as it's not kept in
version control. To create the script, the build system needs to be
bootstrapped. There are many ways to do this, but the easiest one is
to use the supplied autogen.sh script:
The test suite requires cmocka_ and valgrind_.

.. code-block:: shell
$ ./autogen.sh
Benchmarks
==========

The library uses a separate repository for some additional benchmarks_.

.. figure:: https://cloud.githubusercontent.com/assets/2116262/22250690/1e9e74ca-e248-11e6-8366-6356e8611c06.png

``Intel(R) Xeon(R) CPU E5-2623 v3 @ 3.00GHz``
$ ./configure
$ make check
.. _cmocka: https://cmocka.org/
.. _valgrind: http://valgrind.org/
Expand Down

0 comments on commit e76983e

Please sign in to comment.