From c32b8c478e2cfb02a083c637216e19027171ff4f Mon Sep 17 00:00:00 2001
From: B13nch3n <b13nch3n_01@theb-si.de>
Date: Thu, 5 May 2022 20:10:06 +0200
Subject: [PATCH] Start validation README

---
 README.md            | 10 +++++++++-
 validation/README.md | 20 ++++++++++++++++++++
 2 files changed, 29 insertions(+), 1 deletion(-)
 create mode 100644 validation/README.md

diff --git a/README.md b/README.md
index ac490c5..c1daa0c 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,14 @@
 
 This is a collection of tools, code and examples used for converting user's modelling projects into [ModelCIF format](https://mmcif.wwpdb.org/dictionaries/mmcif_ma.dic/Index/) for upload to [ModelArchive](https://www.modelarchive.org) (MA). The whole repository has grown over time from bulk uploads to MA, we assisted users with. Do not expect everything to work out of the box, old conversion projects may be outdated by now.
 
+
+## ModelCIF resources
+
+The official documentation of [ModelCIF](https://mmcif.wwpdb.org/dictionaries/mmcif_ma.dic/Index/) and [PDBx/mmCIF](https://mmcif.wwpdb.org/dictionaries/mmcif_pdbx_v50.dic/Index/) can be found here: https://mmcif.wwpdb.org
+
+ModelCIF dictionary files can be found in the official repository: https://github.com/ihmwg/ModelCIF
+
+
 ## Directories
 
 A short overview of the directories in this repository and what they do.
@@ -11,5 +19,5 @@ A short overview of the directories in this repository and what they do.
 |projects/  |Collection of model conversions done for various user projects. |
 |validation/|A tool to check the formatting of ModelCIF files.               |
 
-<!--  LocalWords:  modelcif ModelArchive
+<!--  LocalWords:  modelcif ModelArchive PDBx
  -->
diff --git a/validation/README.md b/validation/README.md
new file mode 100644
index 0000000..697e5bb
--- /dev/null
+++ b/validation/README.md
@@ -0,0 +1,20 @@
+# ModelCIF validation tool
+
+This is a tool to check that the formatting of ModelCIF files complies with the ModelCIF format declaration (aka "dictionary"). Upon successful validation, a ModelCIF file can be extended with the dictionary version the file was compared to (option ToDo: add option). For more basic mmCIF validation, the dictionary of the underlying PDBx/mmCIF format is also available.
+
+The easiest way to run validation is from Docker container. Running it out of Docker requires an installation of [OpenStructure](https://openstructure.org).
+
+[[_TOC_]]
+
+- how to run the tool
+
+- how to run the container
+
+- how to pull the container
+
+- how to build the container
+
+- files (at the bottom)
+
+<!--  LocalWords:  PDBx
+ -->
-- 
GitLab