docs(readme): update installation instructions with submodule

remarkablemark · Aug 3, 2019 · 3866e7d · 3866e7d
1 parent 968d7dc
commit 3866e7d
Showing 1 changed file with 11 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -21,14 +21,23 @@ $ bundler --version
 
 ## Installation
 
-Clone the repository:
+Clone the repository with SSH:
+
+```sh
+$ git clone --recursive git@github.com:remarkablemark/remarkablemark.github.io.git
+$ cd remarkablemark.github.io
+```
+
+Or clone the repository with HTTPS:
 
 ```sh
 $ git clone https://github.com/remarkablemark/remarkablemark.github.io.git
 $ cd remarkablemark.github.io
+$ sed -i '' 's/:/\//; s/git@/https:\/\//' .gitmodules
+$ git submodule update --init --recursive
 ```
 
-Install dependencies:
+Install the dependencies:
 
 ```sh
 $ bundle install