aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAaron LI <aly@aaronly.me>2019-07-14 12:30:17 +0800
committerAaron LI <aly@aaronly.me>2019-07-14 12:30:17 +0800
commit8b0ba74be9deb2bae927c7eb7a878cbbd6283994 (patch)
tree1493c75778e92088dfaa25ae6690ec424c13b1bb
parentcd28dac0b11eccc5599591fe631eb36eecf194cf (diff)
downloaddotfiles-8b0ba74be9deb2bae927c7eb7a878cbbd6283994.tar.bz2
README: Document git clone and submodules update
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index c190d4b..3390034 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,23 @@ Aly's dotfiles
Personal & collected dotfiles ~~~
+Usage
+-----
+Clone with submodules:
+
+ $ git clone --recurse-submodules https://github.com/liweitianux/dotfiles
+
+Or to initialize the submodules included in this repo:
+
+ $ git submodule update --init --recursive
+
+To update this repo:
+
+ $ git pull
+
+To update the submodules:
+
+ $ git submodule update --remote --recursive
License
-------