Completely working Makefile and Readme with documentation on how to c…

…all make

Makefile

@@ -1,19 +1,27 @@
 TOPDIR=$(shell pwd)
 
+
 build: ## Build docker image
 	docker build -t yfd-jekyll .
 	docker run -p 4000:4000 --volume="$(TOPDIR):/workspaces/yfd-docs" -dit --name yfd-docs yfd-jekyll
 ##	docker-compose build
 
-start:build
-##	docker-compose up --force-recreate
-	docker exec -it -w /workspaces/yfd-docs yfd-docs sh -c "bundle exec jekyll serve --host 0.0.0.0 --config _config_local.yml"
+start:
+#	docker-compose up --force-recreate
+	docker start yfd-docs
+	docker exec -d -it -w /workspaces/yfd-docs yfd-docs sh -c "bundle exec jekyll serve --host 0.0.0.0 --config _config_local.yml"
 
+	@echo "YFD Docs service is starting... please wait 10 seconds."
+	@echo "Open http://localhost:4000/ in your preferred web browser."
 stop: 
 ##	docker-compose stop
+	docker stop yfd-docs
 
 rebuild: # run jekyll build inside container to update on the go
 ##	docker-compose exec jekyll jekyll build --incremental --watch
+	make clean
+	make build
+	make start
 
 open:
 	docker exec -it yfd-docs "/bin/ash"

README.md

@@ -1,4 +1,4 @@
-# Y-Foundry Wiki Repository
+# Y-Foundry Documentation Repository
 
 Built with Github Pages and [Jekyll](https://jekyllrb.com/)
 
@@ -10,20 +10,45 @@ Built with Github Pages and [Jekyll](https://jekyllrb.com/)
 
 
 ## Setting up a documentation environment locally
-First this:
-https://jekyllrb.com/docs/installation/ubuntu/
 
-then:
-[Jekyll](https://jekyllrb.com/docs/step-by-step/01-setup/)
+## Pre-requestites ##
+
+1. Git
+
+2. Docker
 
 ### Clone YFD-WIKI Repo
 ```git clone https://github.com/Y-Foundry-Dao/yfd-wiki.git```
 
-### From the ```yfd-wiki``` directory
-```bundle install```
+### From the ```yfd-wiki``` cloned repo directory
+
+`make build`
+To build the Docker Image and Container
+
+*** 
+`make start`
+To launch the Documentation Service
+
+Open a browser to [local documentation site](http://localhost:4000)
+
+***
+
+#### Other Commands
+
+`make stop`
+
+To stop the development environment
+
+*** 
+`make rebuild`
+To rebuild the local development environment
+
+***
+`make clean`
+To clean image and container files
 
-```bundle exec jekyll serve --config _config_local.yml```
 
+*** 
 
 ## For Reference