Skip to content

Commit

Permalink
Update the documentation and version requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
Pansanel committed Jan 30, 2025
1 parent 60c1560 commit 20b46e3
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 10 deletions.
29 changes: 23 additions & 6 deletions INSTALL.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,25 @@ Requirements

The following are required to build Mychem:

* cmake v2.4.5 or higher
* cmake v3.10 or higher
* libmysqlclient-dev v5.0 or higher (or the MariaDB equivalent)
* openbabel-dev v2.3.0 or higher
* openbabel-dev v3.0 or higher


Quick Install
-------------

This section describes a simple way to compile and install Mychem on
GNU/Linux. For a more complete documentation about the installation
procedure (in particular on Windows and Mac OS X), see the
procedure (in particular on Mac OS X), see the
`online documentation <https://mychem.github.io/docs/installation.html>`_.


Get the last stable release
+++++++++++++++++++++++++++

The last stable release can be downloaded from the `Mychem GitHub release page <//github.com/mychem/mychem-code/releases/download/v1.0.1/mychem-1.0.1.tgz>`_.
The last stable release can be downloaded from the
`Mychem GitHub release page <https://github.com/mychem/mychem-code/releases/>`_.

Uncompress the code
+++++++++++++++++++
Expand All @@ -33,7 +35,8 @@ code with:

::

$ tar xfzv mychem-1.0.1.tgz
$ tar xfzv mychem-2.0.0.tgz


Compilation and Installation
++++++++++++++++++++++++++++
Expand All @@ -46,7 +49,7 @@ this short tutorial:

::

$ cd mychem-1.0.1
$ cd mychem-2.0.0
$ mkdir build
$ cd build
$ cmake ..
Expand All @@ -60,3 +63,17 @@ It is done with the following command:

$ mysql -u user -p < src/mysqldb.sql

On Ubuntu, the following additional steps are required:

1. Add the following line to the ``/etc/apparmor.d/local/usr.sbin.mysqld``

::

/usr/lib/openbabel/** r,

2. Reload the AppArmor configuration:

::

$ cat /etc/apparmor.d/usr.sbin.mysqld | apparmor_parser -r

11 changes: 7 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,29 @@ The Mychem Project

Mychem is a chemoinformatics extension for MySQL. This extension
provides a set of functions that handles chemical data within the MySQL
(or MariaDB) database. Mychem is based on `Open Babel <http://openbabel.org/wiki/Main_Page>`_.
(or MariaDB) database. Mychem is based on `Open Babel <https://openbabel.org/>`_.
As Open Babel is a high-quality software in chemoinformatics, Mychem
provides reliable and fast functions. These functions permit you to
search, analyze and convert chemical data.

More information are available from the `Mychem Website <http://mychem.github.io>`_.
More information are available from the `Mychem Website <https://mychem.github.io>`_.


Documentation
-------------

A complete and detailed documentation is available `online <http://mychem.github.io/docs/index.html>`_.
A complete and detailed documentation is available `online <https://mychem.github.io/docs/index.html>`_.
A `pdf version <https://mychem.github.io/mychem-latest.pdf>`_ can also be
downloaded.


Installation
------------

See the `INSTALL.rst <https://github.com/mychem/mychem-code/blob/master/INSTALL.rst>`_
file for the installation instructions on GNU/Linux. Instructions for
Mac OS X and Windows are given on the dedicated `documentation page <https://mychem.github.io/docs/installation.html>`_ .
Mac OS X and Windows are given on the dedicated
`documentation page <https://mychem.github.io/docs/installation.html>`_ .


License
Expand Down

0 comments on commit 20b46e3

Please sign in to comment.