Mercurial > template

view INSTALL.md @ 19:3b6c3405b9f3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add some files in .hgignore and document it
author David Demelier <markand@malikania.fr>
date Fri, 20 Oct 2017 11:52:55 +0200
parents a8462a503697
children 0706d01e073f
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