jmm/autodoc
1
0
Fork 0
mirror of https://github.com/ldericher/autodoc.git synced 2025-12-06 15:43:01 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

readme typo

Browse source
This commit is contained in:
Jörn-Michael Miehe 2019-09-24 17:39:07 +02:00
parent 861c888b5e
commit 170e3527bf
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -2,7 +2,7 @@
[`autodoc`](https://github.com/ldericher/autodoc) is a simple [CI](https://en.wikipedia.org/wiki/Continuous_integration) system optimized for document creation. [`autodoc`](https://github.com/ldericher/autodoc) is a simple [CI](https://en.wikipedia.org/wiki/Continuous_integration) system optimized for document creation.
In general, any file-sharing solution -- preferably on top of `docker-compose` -- can be made into an automatic document distribution system by adding an `autodoc` instance. In general, any file-sharing solution – preferably on top of `docker-compose` – can be made into an automatic document distribution system by adding an `autodoc` instance.
## Quick Start Guide using Docker ## Quick Start Guide using Docker
@ -16,16 +16,16 @@ The `autodoc` image [available on Docker Hub](https://hub.docker.com/r/ldericher
```bash ```bash
docker run --rm -it \ docker run --rm -it \
--volume "${PWD}":/docs \ --volume "${PWD}":/docs \
--user "$(id -u):$(id -g)" \ --user "$(id -u):$(id -g)" \
ldericher/autodoc ldericher/autodoc
``` ```
The contents of the directory are now being watched by `autodoc`! The contents of the directory are now being watched by `autodoc`!
When deploying an `autodoc` container, just mount your document root to `/docs`. You *should* also set the container's UID and GID. These are seen above. When deploying an `autodoc` container, just mount your document root to `/docs`. You *should* also set the container's UID and GID. These are seen above.
01. Edit some stuff, save -- and watch the magic happen (and the terminal output). 01. Edit some stuff, save – and watch the magic happen (and the terminal output).
On each file change, `autodoc` searches relevant build instruction files (Makefiles etc.) and kicks off build processes accordingly. On each file change, `autodoc` searches relevant build instruction files (Makefiles etc.) and kicks off build processes accordingly.