summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKuninori Morimoto <kuninori.morimoto.gx@renesas.com>2019-12-23 14:26:01 +0900
committerKuninori Morimoto <kuninori.morimoto.gx@renesas.com>2019-12-23 14:26:01 +0900
commit05040a728026b28ce7c6183d2adfa80218b306cb (patch)
tree5d83ccbc2e5435709fda8d09cb169c3a40b33553
parent7c50430474bd175aecb6f46f40921ec03eeb12e0 (diff)
README.md: update for HTML/Wiki
Wiki needs textile patchage, but its explanation was added at non-top. It is not easy to understand. This patch tidyup HTML/Wiki explanation. Signed-off-by: Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
-rw-r--r--README.md25
1 files changed, 12 insertions, 13 deletions
diff --git a/README.md b/README.md
index 6807791..897ca40 100644
--- a/README.md
+++ b/README.md
@@ -53,24 +53,23 @@ You need to have **.config** file. You can copy sample .config, and edit it
* --oneline : show one line
* --all : show all tasks
-# HTML
+# HTML / Wiki
## How to create HTML ?
-It is easy ! just "make"
-You can find index.html on top of periject folder
-But, You need to have **.config** file. You can copy sample .config, and edit it
-Your .config need to have "git-linux" and it need to have bsp repository
-You can add it by
+You need to install "textile" first for Wiki, by using one of:
- > git remote add bsp git://git.kernel.org/pub/scm/linux/kernel/git/horms/renesas-bsp.git
+ > pip install textile
+or
+ > sudo apt install python3-textile
-# Wiki
+Next, you need to have **.config** file. You can copy sample .config, and edit it
-## How to create Wiki ?
-It is easy ! just "wiki"
+Your .config need to have "git-linux" and it needs to have both "linux" and "bsp" repository.
+You can add it by
-You need to install "textile" first, by using one of:
+ > git remote add linux git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
+ > git remote add bsp git://git.kernel.org/pub/scm/linux/kernel/git/horms/renesas-bsp.git
- > pip install textile
- > sudo apt install python3-textile
+Then, just "make".
+You can find index.html on top of periject folder