Updated documentation

Author: krom

CHANGELOG.md

@@ -1,6 +1,7 @@
 ## 1.0.2 (2008-06-08)
 * Added showing release notes while upgrading
-* Changed create Makefile from Makefile.sample.mk instead of HEADER.mk
+* Added Makefile.minimal.mk with basic commands
+* Changed create Makefile from Makefile.minimal.mk instead of HEADER.mk
 
 ## 1.0.1 (2018-06-06)
 * Added Makefile.sample.mk

README.md

@@ -26,17 +26,25 @@ make mk-upgrade
 ## USAGE
 ![Screen](https://raw.githubusercontent.com/krom/docker-compose-makefile/master/docs/screencast.gif)
 
-**Common (see [samples](https://github.com/krom/docker-compose-makefile/tree/master/samples))**
-- **make start** - start all containers
-- **make start c=hello** - start container hello
-- **make stop** - stop all containers
-- **make status** - show list of containers with statuses
-- **make clean** - clean all data
+**Common** (see [samples](https://github.com/krom/docker-compose-makefile/tree/master/samples))
+- `make console` - open container's console
+
+**From Makefile.minimal.mk** (see [samples](https://github.com/krom/docker-compose-makefile/tree/master/samples))
+- `make start` - start all containers
+- `make start` c=hello** - start container hello
+- `make stop` - stop all containers
+- `make status` - show list of containers with statuses
+- `make clean` - clean all data
 
 **From this library**
-- **make help** - show help (see above)
-- **make mk-upgrade** - check for updates of mk-lib
-- **make mk-version** - show current version of mk-lib
+- `make help` - show help (see above)
+- `make mk-upgrade` - check for updates of mk-lib
+- `make mk-version` - show current version of mk-lib
+
+### VARIABLES
+* **ROOT_DIR** - full path to dir with *Makefile*
+* **DOCKER_COMPOSE** - docker-compose executable command
+* **DOCKER_COMPOSE_FILE** - docker-compose.yml file 
 
 ## SAMPLES
 
@@ -69,8 +77,8 @@ You can create _.make.env_ file in directory with Makefile or **current** direct
 
 Available variables
 
-* DOCKER_COMPOSE = {docker-compose executable command}
-* DOCKER_COMPOSE_FILE = {custom docker-compose.yml file}
+* **DOCKER_COMPOSE** = {docker-compose executable command}
+* **DOCKER_COMPOSE_FILE** = {custom docker-compose.yml file}
 
 ## TO-DO
 - check dependencies

samples/Makefile.minimal.mk

@@ -0,0 +1,29 @@
+# REQUIRED SECTION
+ROOT_DIR:=$(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
+include $(ROOT_DIR)/.makefile-lib/common.mk
+# END OF REQUIRED SECTION
+
+.PHONY: help dependencies up start stop restart status ps clean
+
+dependencies: check-dependencies ## Check dependencies
+
+up: ## Start all or c=<name> containers in foreground
+	@$(DOCKER_COMPOSE) -f $(DOCKER_COMPOSE_FILE) up $(c)
+
+start: ## Start all or c=<name> containers in background
+	@$(DOCKER_COMPOSE) -f $(DOCKER_COMPOSE_FILE) up -d $(c)
+
+stop: ## Stop all or c=<name> containers
+	@$(DOCKER_COMPOSE) -f $(DOCKER_COMPOSE_FILE) stop $(c)
+
+restart: ## Restart all or c=<name> containers
+	@$(DOCKER_COMPOSE) -f $(DOCKER_COMPOSE_FILE) stop $(c)
+	@$(DOCKER_COMPOSE) -f $(DOCKER_COMPOSE_FILE) up $(c) -d
+
+status: ## Show status of containers
+	@$(DOCKER_COMPOSE) -f $(DOCKER_COMPOSE_FILE) ps
+
+ps: status ## Alias of status
+
+clean: ## Clean all data
+	@$(DOCKER_COMPOSE) -f $(DOCKER_COMPOSE_FILE) down

scripts/build.sh

@@ -11,6 +11,7 @@ cp README.md $OUT
 cp LICENSE $OUT
 cp CHANGELOG.md $OUT
 cp samples/Makefile $OUT/Makefile.sample.mk
+cp samples/Makefile.minimal.mk $OUT/Makefile.minimal.mk
 
 # Writing current version
 echo "MK_VERSION := $TRAVIS_TAG" > $OUT/version.mk

scripts/install.sh

@@ -31,6 +31,6 @@ if [ -f Makefile ]; then
     echo "-------------------------------------------------------------------------------
 "
 else
-    cp .mk-lib/Makefile.sample.mk Makefile
+    cp .mk-lib/Makefile.minimal.mk Makefile
     echo "Created new Makefile. Feel free to add new commands"
 fi;