Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/queensferryme/hugo-theme-texify.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorQueensferry <queensferry.me@gmail.com>2021-02-26 11:24:16 +0300
committerQueensferry <queensferry.me@gmail.com>2021-02-26 11:24:16 +0300
commitca87543be2ea7e4bc18956c0e5063c5fea3ef61c (patch)
tree280635d0d36b980b1ce25cbf9ad83898156b6618
parentf8c0c8f65786fc2798f93f438a6e67d68c8e227c (diff)
chore: update README.md
-rw-r--r--README.md18
1 files changed, 11 insertions, 7 deletions
diff --git a/README.md b/README.md
index f868a25..bb06e13 100644
--- a/README.md
+++ b/README.md
@@ -14,8 +14,17 @@ A minimal, latex-style hugo theme for personal blogging.
## Usage
+Install with:
+
+```bash
+git submodule add https://github.com/queensferryme/hugo-theme-texify.git themes/hugo-theme-texify
+cp themes/hugo-theme-texify/exampleSite/config.toml config.toml
+```
+
+Upgrade with:
+
```bash
-git clone https://github.com/queensferryme/hugo-theme-texify.git themes/hugo-theme-texify
+git submodule foreach git pull origin master
```
See `exampleSite/config.toml` for an example configuration.
@@ -33,12 +42,7 @@ Note that for Simplified Chinese users, it is generally recommended to use [Noto
## Development
```bash
-hugo server \
- --buildDrafts \
- --config="exampleSite/config.toml" \
- --contentDir="exampleSite/content" \
- --disableFastRender \
- --themesDir=".."
+make dev
```
## Acknowledgement