#10: Added build documentation instruction in README

IntegraSDL · Dec 28, 2022 · 17f4d61 · 17f4d61
1 parent d5fa168
commit 17f4d61
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -127,3 +127,4 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+.DS_Store
diff --git a/README.md b/README.md
@@ -11,3 +11,17 @@ This library might be used to automate testing process with Xvbf and docker.
 
 pyGATs depends on pyautogui, pytesseract, opencv and others. Please see section
 dependencies in pyproject.toml file.
+
+
+## How to test
+
+```
+python3 -m pytest
+```
+
+## Build documentation
+
+```
+cd docs
+make html
+```
Original file line number	Diff line number	Diff line change
Expand Up		@@ -127,3 +127,4 @@ dmypy.json

		# Pyre type checker
		.pyre/
		.DS_Store