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

github.com/hadisinaee/avicenna.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHadi Sinaee <sinaee@cs.ubc.ca>2021-06-13 19:32:59 +0300
committerHadi Sinaee <sinaee@cs.ubc.ca>2021-06-13 19:32:59 +0300
commit3b69bc59fbfd2c9811c09dd373f8ce1f6eed7a39 (patch)
tree0a093cf8c84904a4092f47a2f7786b8cb4f650c9
parent19a679a50cd119c2ead3a7fb024eaf0e3585f4d7 (diff)
doc: change first and second approach order
-rw-r--r--README.md38
1 files changed, 20 insertions, 18 deletions
diff --git a/README.md b/README.md
index 516c07c..706006d 100644
--- a/README.md
+++ b/README.md
@@ -19,12 +19,27 @@ To use `Avicenna`, you need to follow three steps:
The following sections are based on the mentioned steps.
# 1. How to setup a site with `Avicenna`?
There are 2 ways to install `Avicenna`:
-1. The first one is a step-by-step approach that you could use to install it.
-2. The second one is just an automated script based on the first approach.
+1. The first one is just an automated script based on the second approach(recommended).
+2. The sedond one is a step-by-step approach.
-Pick the one that works for you well. Also, I provided a link to a video clip showing the whole process of installation for both approaches.
+## 1. Automated Script
+In this approach, all you need is to replace the `my_cool_page` with your desired name in the following script:
-## 1. Step-by-Step Installation
+```bash
+wget https://raw.githubusercontent.com/hadisinaee/avicenna/master/setup_avicenna.sh && sh setup_avicenna.sh my_cool_page
+```
+
+Run the site:
+```bash
+hugo serve
+```
+
+Now, you should be able to see the site at http://localhost:1313
+
+## 2. Step-by-Step Installation
+<details>
+ <summary>Click to see!</summary>
+
1. You need to install [Hugo][1] first!
2. Create a new site and go to the directory:
```bash
@@ -51,20 +66,7 @@ hugo serve
```
Now, you should be able to see the site at [http://localhost:1313](http://localhost:1313/)
-
-## 2. Automated Script
-In this approach, all you need is to replace the `my_cool_page` with your desired name in the following script:
-
-```bash
-wget https://raw.githubusercontent.com/hadisinaee/avicenna/master/setup_avicenna.sh && sh setup_avicenna.sh my_cool_page
-```
-
-Run the site:
-```bash
-hugo serve
-```
-
-Now, you should be able to see the site at http://localhost:1313
+</details>
# 2. How to Customize `Avicenna`?