From dc268a5cf87fc9f847f6f169f5ed3efa6d8e711e Mon Sep 17 00:00:00 2001
From: Graeme Nail <graemenail.work@gmail.com>
Date: Tue, 8 Feb 2022 13:14:45 +0000
Subject: Add marian-example-library submodule and short description

---
 .gitmodules     |  3 +++
 README.md       | 24 ++++++++++++++----------
 example-library |  1 +
 3 files changed, 18 insertions(+), 10 deletions(-)
 create mode 100644 .gitmodules
 create mode 160000 example-library

diff --git a/.gitmodules b/.gitmodules
new file mode 100644
index 0000000..1eb43bf
--- /dev/null
+++ b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "example-library"]
+	path = example-library
+	url = https://github.com/marian-nmt/marian-example-library
diff --git a/README.md b/README.md
index dc42b1c..14a0768 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ Examples, tutorials and use cases for the Marian toolkit.
 
 More information on https://marian-nmt.github.io
 
-List of examples:
+## Examples
 * `translating-amun` -- examples for translating with Amun
 * `training-basics` -- the complete example for training a WMT16-scale model
 * `training-basics-sentencepiece` -- as `training-basics`, but uses built-in SentencePiece for data processing, requires Marian v1.7+
@@ -12,21 +12,26 @@ List of examples:
 * `wmt2017-uedin` -- scripts for building a WMT2017-grade model for en-de based on Edinburgh's WMT2017 submission
 * `wmt2017-transformer` -- scripts for building a better than WMT2017-grade model for en-de, beating WMT2017 submission by 1.2 BLEU
 
-## Usage
+### Usage
 
 First download common tools:
-
-    cd tools
-    make all
-    cd ..
+```shell
+cd tools
+make all
+cd ..
+```
 
 Next, go to the chosen directory and run `run-me.sh`, e.g.:
-
-    cd training-basics
-    ./run-me.sh
+```shell
+cd training-basics
+./run-me.sh
+```
 
 The README file in each directory provides more detailed description.
 
+## Templates
+* `example-library` -- example using Marian as a library demonstrating basic graph operations, available as a repository [template](https://github.com/marian-nmt/marian-example-library/generate)
+
 ## Acknowledgements
 
 The development of Marian received funding from the European Union's
@@ -39,4 +44,3 @@ the Amazon Academic Research Awards program, and
 the World Intellectual Property Organization.
 
 This software contains source code provided by NVIDIA Corporation.
-
diff --git a/example-library b/example-library
new file mode 160000
index 0000000..a33ef10
--- /dev/null
+++ b/example-library
@@ -0,0 +1 @@
+Subproject commit a33ef1055cbb3b7a8003138e9669d406a7bde42f
-- 
cgit v1.2.3