From: Ulya Trofimovich Date: Tue, 20 Oct 2015 16:34:09 +0000 (+0100) Subject: Install page. X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=e1a89d88229b12c323e7c910478a001071cf34fb;p=re2c Install page. --- diff --git a/src/css/default.css b/src/css/default.css index 92a4c3a0..349654b2 100644 --- a/src/css/default.css +++ b/src/css/default.css @@ -1,6 +1,9 @@ body { text-align: justify; - margin: auto auto auto auto; + margin-top: 1%; + margin-right: auto; + margin-bottom: 1%; + margin-left: auto; width: 85%; } diff --git a/src/download.rst b/src/download.rst deleted file mode 100644 index e69de29b..00000000 diff --git a/src/index.rst b/src/index.rst index 8be659d6..3229f60b 100644 --- a/src/index.rst +++ b/src/index.rst @@ -9,7 +9,7 @@ and flexible (easy to embed into existing environment). -------------------------------------------------------------------------------- -`Download `_ +`Install `_ --------------------------- `Manual `_ ----------------------- @@ -21,3 +21,4 @@ and flexible (easy to embed into existing environment). Please send feedback to `re2c-devel `_ and `re2c-general `_ mailing lists or `report a bug `_. +Contributors welcome! diff --git a/src/install.rst b/src/install.rst new file mode 100644 index 00000000..e4d7f29d --- /dev/null +++ b/src/install.rst @@ -0,0 +1,181 @@ + +`[home] `_ + +-------------------------------------------------------------------------------- + +* `Download`_ + - `Tarballs`_ + - `Sources`_ + - `Distributions`_ +* `Build`_ + - `Bootstrap`_ + - `Out-of-source`_ + - `Windows`_ +* `Test`_ + +.. _Download: + +Download +======== +-------------------------------------------------------------------------------- + +.. _Tarballs: + +Tarballs +-------- + +* `re2c-0.14.3.tar.gz `_ +* `re2c-0.13.7.5.tar.gz `_ +* `re2c-0.13.6.tar.gz `_ +* `re2c-0.13.5.tar.gz `_ + +.. _Sources: + +Sources +------- + +re2c is hosted on `github `_: + +.. code-block:: bash + + $ git clone git@github.com:skvadrik/re2c.git re2c + +There's also a mirror on `sourceforge `_ +(should be in sync with github): + +.. code-block:: bash + + $ git clone ssh://git.code.sf.net/p/re2c/code-git re2c + +.. _Distributions: + +Distributions +------------- + +Linux +~~~~~ + +* `Alt `_ +* `Arch `_ +* `Debian `_ +* `Gentoo `_ +* `Fedora `_ +* `Mageia `_ +* `Mandriva `_ +* `OpenSuSE `_ +* `RedHat `_ +* `Slackware `_ +* `Ubuntu `_ + +Summary of available re2c versions in many (but not all) Linux distributions +can be found on `pkgs.org `_. + +BSD +~~~ + +* `Apple Mac OS X `_ +* `FreeBSD `_ +* `NetBSD `_ +* `OpenBSD `_ + +.. _Build: + +Build +===== +-------------------------------------------------------------------------------- + +If you are building re2c from sources, you'll first need to generate autotools files: + +.. code-block:: bash + + $ ./autogen.sh + +Simply configure, build and install re2c (binary and manpage) to ``prefix`` (``/usr/local`` by default): + +.. code-block:: bash + + $ ./configure [--prefix=] + $ make + $ make install + +.. _Bootstrap: + +Bootstrap +--------- + +Some parts of re2c (lexers and parser of command-line options) are written in re2c. +These files are precompiled and packaged into re2c distribution (so that re2c can be built without re2c). +However, one can fully bootstrap re2c: + +.. code-block:: bash + + $ make bootstrap + +.. _Out-of-source: + +Out-of-source +------------- + +re2c supports out-of-source builds: + +.. code-block:: bash + + $ mkdir builddir && cd builddir + $ ../configure [--prefix=] + $ make + $ make install + +.. _Windows: + +Windows +------- + +If you intend to use re2c on Windows, you can either +use `cygwin `_ +or build re2c with `mingw `_: + +.. code-block:: bash + + $ ../configure --host i686-w64-mingw32 [--prefix=] + $ make + $ make install + +(mingw builds are supported and tested regularly). + +.. _Test: + +Test +==== +-------------------------------------------------------------------------------- + +re2c has a main test suite and a couple of small tests. Run them all: + +.. code-block:: bash + + $ make check + +Or run only the main test suite (and watch progress dumped to ``stdout``): + +.. code-block:: bash + + $ make tests + +Run test suite under `valgrind `_ (takes a long time): + +.. code-block:: bash + + $ make vtests + +Test mingw builds with `wine `_: + +.. code-block:: bash + + $ make wtests + +Check the distribution: + +.. code-block:: bash + + $ make distcheck + + diff --git a/src/manual.rst b/src/manual.rst index 11acceed..35bb1a3b 100644 --- a/src/manual.rst +++ b/src/manual.rst @@ -50,7 +50,7 @@ Since then many people have contributed to re2c: * Dan Nuffer nuffer@users.sourceforge.net * Marcus Boerger helly@users.sourceforge.net * Hartmut Kaiser hkaiser@users.sourceforge.net -* Emmanuel Mogenet mgix@mgix.com (added storable state) +* Emmanuel Mogenet mgix@mgix.com * Ulya Trofimovich skvadrik@gmail.com Let me know if I missed someone!