aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJan-Simon Möller <dl9pf@gmx.de>2019-11-08 13:05:50 +0100
committerGitHub <noreply@github.com>2019-11-08 13:05:50 +0100
commit68817f0d117f10e3f15265cb14d1a43b8e6905b4 (patch)
tree5446fba6ee68309000564c1545b0b9270baf27e9 /README.md
parent3b0d13c64f33a034ffeeedb97389a7526147b415 (diff)
parent2c15432274a49d88e0a9f4887e77bbe4d74c77ac (diff)
Merge pull request #12 from walzert/master
Fixed the paths form TODO part
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/README.md b/README.md
index 97cb948..49f4455 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,6 @@
This repository contains AGL documentation website template, rendering is visible at http://docs.automotivelinux.org
This website relies on the generator located in [docs-tools](https://github.com/automotive-grade-linux/docs-tools)
-TODO: old documentation below. Should be rewritten to match new git repo scheme.
# Installing
@@ -35,13 +34,14 @@ Other configuration files in conf/ starting by an underscore (_) are used by Jek
## generate a 1st site from your template
```bash
- ./doctools/webdocs/docbuild --clean # deleted all generated file if any
- ./doctools/webdocs/docbuild --fetch [--force] # collect doc from github (fetch list in content/toc/*/fetch_files.yml)
- ./doctools/webdocs/docbuild --build --serve --watch --incremental # build config/tocs, generate html and start a local webserver
+ ./doctools/docbuild --clean # deleted all generated file if any
+ ./doctools/docbuild --fetch [--force] # collect doc from github (fetch list in content/toc/*/fetch_files.yml)
+ ./doctools/docbuild --build --serve --watch --incremental # build config/tocs, generate html and start a local webserver
+
xdg-open http://localhost:4000
- ./doctools/webdocs/docbuild --push --verbose # push generated to production webserver (check conf/AppDefault 1st)
+ ./doctools/docbuild --push --verbose # push generated to production webserver (check conf/AppDefault 1st)
```
Alternatively, a Makefile can be used and defines the most common operations:
@@ -96,4 +96,4 @@ Thus, this file is needed to be added in the docs-webtemplate root, see an examp
```bash
--watch to automatically regenerate pages on markdown file, you should force "./build --configs" when changing TOC or versions.
-``` \ No newline at end of file
+```