From c5ac0c59700a7377a55be90e4dbe64c849e693bb Mon Sep 17 00:00:00 2001 From: Anthony Scemama Date: Thu, 3 Apr 2014 09:19:24 +0200 Subject: [PATCH] Changed README to rst --- README.md => README.rst | 2 +- src/coding_rules.rst | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) rename README.md => README.rst (64%) diff --git a/README.md b/README.rst similarity index 64% rename from README.md rename to README.rst index 1192bd72..8de94373 100644 --- a/README.md +++ b/README.rst @@ -4,5 +4,5 @@ Quantum package Set of quantum chemistry programs and libraries. For more information, you can visit the -wiki of the project : http://github.com/LCPQ/quantum_package/wiki +`wiki of the project `_ diff --git a/src/coding_rules.rst b/src/coding_rules.rst index 8b86388d..2d7f8d57 100644 --- a/src/coding_rules.rst +++ b/src/coding_rules.rst @@ -4,11 +4,11 @@ Programming guidelines Each module (directory) contains the following: -* A :file:`readme.rst` file to document the current module. -* An :file:`assumptions.rst` file. This file should document all the implicit +* A :file:`README.rst` file to document the current module. +* An :file:`ASSUMPTIONS.rst` file. This file should document all the implicit assumptions used in the module. For example, if the atomic orbitals are assumed to be normalized, this should be mentioned in the - :file:`AOs/assumptions.rst` file. + :file:`AOs/ASSUMPTIONS.rst` file. * A set of :file:`.irp.f` files containing provider, subroutines and functions * A :file:`tests` directory that should contain the test programs of the module (see testing section)