diff --git a/README.md b/README.md index 0040929..0bd88ff 100644 --- a/README.md +++ b/README.md @@ -1 +1,5 @@ -# inetmock \ No newline at end of file +# INetMock + +## Docs + +Docs are available either in the [`docs/`](./docs/) directory or as rendered markdown book at the [GitHub pages](https://baez90.github.io/inetmock/). \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d9ad9be --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,15 @@ +.PHONY: book deploy + +book: + @mdbook build + +deploy: book + @rm -rf /tmp/book + @git worktree remove -f /tmp/book + @git worktree add /tmp/book gh-pages + @rm -rf /tmp/book/* + @cp -rp book/* /tmp/book/ + @cd /tmp/book && \ + git add -A && \ + git commit -m "deployed on $(shell date) by ${USER}" && \ + git push origin gh-pages \ No newline at end of file