From c923370feb57c36301443b85df6bb11a9a552822 Mon Sep 17 00:00:00 2001 From: Pedro Crespo-Valero Date: Tue, 28 Nov 2017 23:23:50 +0100 Subject: [PATCH] Cleanup of doc --- demos/wasm/README.md | 7 ++++ docs/README.md | 5 --- docs/docker-cheatsheet.md | 74 +++++++++++++++++++++++++++++++++++ docs/git-cheatsheet.md | 10 +++++ templates/README.md | 3 ++ templates/demo-tmpl/Makefile | 8 ++++ templates/demo-tmpl/README.md | 3 ++ 7 files changed, 105 insertions(+), 5 deletions(-) create mode 100644 demos/wasm/README.md delete mode 100644 docs/README.md create mode 100644 docs/docker-cheatsheet.md create mode 100644 docs/git-cheatsheet.md create mode 100644 templates/demo-tmpl/Makefile diff --git a/demos/wasm/README.md b/demos/wasm/README.md new file mode 100644 index 00000000..3bc2e745 --- /dev/null +++ b/demos/wasm/README.md @@ -0,0 +1,7 @@ +# WebAssembly (wasm) + + + +**Resources** + - http://www.webassembly.org + - https://github.com/chrisber/webassembly-webpack-starter-project diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index bc54ea1e..00000000 --- a/docs/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# Documentation - -This folder contains any sort of reference documentation to support the development of this project - - - [Coding Guidelines](coding-guidelines.md) diff --git a/docs/docker-cheatsheet.md b/docs/docker-cheatsheet.md new file mode 100644 index 00000000..5c7fe2ca --- /dev/null +++ b/docs/docker-cheatsheet.md @@ -0,0 +1,74 @@ +# Dockers CLI Cheatsheet + +### Images +- Lifecycle +```!bash + docker import + docker build + docker commit + docker rmi + docker load + docker save +``` +- History/tagging +``` + docker history + docker tag +``` +- Registry +``` + docker login + docker logout + docker search + docker push + docker pull +``` + +### Containers +- Lifecycle +```!bash + docker create + docker rename + docker run + docker rm + docker update +``` +- Running +```!bash + docker start + docker stop + docker restart + docker pause + docker unpause + docker wait + docker kill + docker attach + ``` +- Info +```!bash + docker ps + docker logs + docker inspect + docker events + docker port + docker top + docker stats + docker diff +``` +- Misc +```!bash + docker cp + docker export + docker exec +``` + +### Machine + + +### Stack + + +#### Useful References + - [Docker CLI Reference](https://docs.docker.com/engine/reference/run/) + - [] + - [Yet another Docker cheatsheet](https://medium.com/statuscode/dockercheatsheet-9730ce03630d) diff --git a/docs/git-cheatsheet.md b/docs/git-cheatsheet.md new file mode 100644 index 00000000..814f3dbb --- /dev/null +++ b/docs/git-cheatsheet.md @@ -0,0 +1,10 @@ +# Git CLI Cheatsheet + + + +--- +# Github + + + +#### Useful References diff --git a/templates/README.md b/templates/README.md index e69de29b..88d5650e 100644 --- a/templates/README.md +++ b/templates/README.md @@ -0,0 +1,3 @@ +# Templates + +Add here any copy&paste type of resource that can be handy to e.g. create a new demo/tool folder, ec diff --git a/templates/demo-tmpl/Makefile b/templates/demo-tmpl/Makefile new file mode 100644 index 00000000..a7f6621e --- /dev/null +++ b/templates/demo-tmpl/Makefile @@ -0,0 +1,8 @@ + +# Demo should implement these commands ------------ +demo: + echo "this should launch the demo (detached if possible)" + +stop: + echo "this should stop the demo" +#--------------------------------------------- diff --git a/templates/demo-tmpl/README.md b/templates/demo-tmpl/README.md index f1c03fe6..cc61d674 100644 --- a/templates/demo-tmpl/README.md +++ b/templates/demo-tmpl/README.md @@ -10,3 +10,6 @@ - What licenses the tools used in this demo has? Is it compatible with the project policy? - Pros - Cons + + +More details on [Markup](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) )