From 20b46e309818ceff8793190227025806a7485d24 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Pansanel?= Date: Thu, 30 Jan 2025 17:11:29 +0100 Subject: [PATCH] Update the documentation and version requirements --- INSTALL.rst | 29 +++++++++++++++++++++++------ README.rst | 11 +++++++---- 2 files changed, 30 insertions(+), 10 deletions(-) diff --git a/INSTALL.rst b/INSTALL.rst index 2362772..21a5a61 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -7,9 +7,9 @@ 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 @@ -17,13 +17,15 @@ 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 `_. + Get the last stable release +++++++++++++++++++++++++++ -The last stable release can be downloaded from the `Mychem GitHub release page `_. +The last stable release can be downloaded from the +`Mychem GitHub release page `_. Uncompress the code +++++++++++++++++++ @@ -33,7 +35,8 @@ code with: :: - $ tar xfzv mychem-1.0.1.tgz + $ tar xfzv mychem-2.0.0.tgz + Compilation and Installation ++++++++++++++++++++++++++++ @@ -46,7 +49,7 @@ this short tutorial: :: - $ cd mychem-1.0.1 + $ cd mychem-2.0.0 $ mkdir build $ cd build $ cmake .. @@ -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 + diff --git a/README.rst b/README.rst index cb48ec2..8432761 100644 --- a/README.rst +++ b/README.rst @@ -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 `_. +(or MariaDB) database. Mychem is based on `Open Babel `_. 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 `_. +More information are available from the `Mychem Website `_. + Documentation ------------- -A complete and detailed documentation is available `online `_. +A complete and detailed documentation is available `online `_. A `pdf version `_ can also be downloaded. + Installation ------------ See the `INSTALL.rst `_ file for the installation instructions on GNU/Linux. Instructions for -Mac OS X and Windows are given on the dedicated `documentation page `_ . +Mac OS X and Windows are given on the dedicated +`documentation page `_ . License