doc(readme): #10 add Makefile doc

alexandre-delaloy · Apr 9, 2021 · 13d4f29 · 13d4f29
1 parent fd4de4d
commit 13d4f29
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 4 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -6,4 +6,4 @@ RUN apt update ; apt install -y software-properties-common gnupg2 shellcheck
 
 COPY . .
 
-CMD [ "bash"]
+CMD [ "bash", "woo.sh" ]
diff --git a/README.md b/README.md
@@ -39,12 +39,27 @@ A **prompt will be displayed**, and depending on the _number_ you enter, an **ac
 
 ![woosh](assets/prompt.png)
 
-## III - Test
+## III - Development
+
+You can test some **Woosh**'s features in a _remote Ubuntu machine_, to avoid **overwriting your local configuration**, by using Makefile.
+
+
+### A - Start
+
+> Start woo.sh in a Ubuntu environment
+
+
+```bash
+make start
+```
+
+### B - Lint
+
+> Start shellcheck lint
 
-You can test some **Woosh**'s features in a _remote Ubuntu machine_, to avoid **overwriting your local configuration**, by using Docker.
 
 ```bash
-docker build -t woosh . ; docker run --rm -it woosh
+make start
 ```
 
 ## IV - License
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,4 +6,4 @@ RUN apt update ; apt install -y software-properties-common gnupg2 shellcheck

		COPY . .

		CMD [ "bash"]
		CMD [ "bash", "woo.sh" ]