Mercurial > template

view INSTALL.md @ 28:1a9a76f94955

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add alerts in markdown style
author David Demelier <markand@malikania.fr>
date Fri, 25 May 2018 16:11:49 +0200
parents 0706d01e073f
children
line wrap: on
line source

PROJECT NAME INSTALL
====================

Installation instructions.

Requirements
------------

- [Library](http://example.org), Short description,
- [Tool](http://example.org), Short description,

Optional:

- [Library](http://example.org), Short recommandation,

Basic installation
------------------

Quick install.

    $ tar xvzf PROJECT NAME-x.y.z-tar.xz
    $ cd PROJECT NAME-x.y.z
    $ mkdir _build_
    $ cd _build_
    $ cmake .. -DCMAKE_BUILD_TYPE=Release
    $ make
    # sudo make install