Update README for docu generation 45/7145/1
authordemx8as6 <martin.skorupski@highstreet-technologies.com>
Mon, 29 Nov 2021 10:14:06 +0000 (11:14 +0100)
committerdemx8as6 <martin.skorupski@highstreet-technologies.com>
Mon, 29 Nov 2021 10:33:11 +0000 (11:33 +0100)
IssueID: OAM-236
Change-Id: If4d9be0d3b28f7682e53eaa039cbdffbb0267fcb
Signed-off-by: demx8as6 <martin.skorupski@highstreet-technologies.com>
README.md

index 17ac781..3ce0e1a 100644 (file)
--- 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.