From: demx8as6 <martin.skorupski@highstreet-technologies.com>
Date: Mon, 29 Nov 2021 10:14:06 +0000 (+0100)
Subject: Update README for docu generation
X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F45%2F7145%2F1;p=oam.git

Update README for docu generation

IssueID: OAM-236
Change-Id: If4d9be0d3b28f7682e53eaa039cbdffbb0267fcb
Signed-off-by: demx8as6 <martin.skorupski@highstreet-technologies.com>
---

diff --git a/README.md b/README.md
index 17ac781..3ce0e1a 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,17 @@
 
 This repository acts as root O-RAN-SC OAM repository. 
 
+## Documentation
+
+The project documentation link is:
+https://docs.o-ran-sc.org/projects/o-ran-sc-oam/en/latest/index.html?highlight=Operation%20and%20mainetance
+
+To generate the documentation the project must be cloned and the following 
+command must be executed:
+```
+ tox -e docs,docs-linkcheck
+```
+
 ## License
 
 This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.