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

github.com/wowchemy/starter-academic.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGeorge Cushen <gcushen@users.noreply.github.com>2017-12-08 03:34:33 +0300
committerGeorge Cushen <gcushen@users.noreply.github.com>2017-12-08 03:34:33 +0300
commit2e84cb9eb5c8ab12c9703c41a89c4379f84b6573 (patch)
treecc3d4bd8d3a6e6dc95f2c817cb95e784a0ab287e /README.md
parentb65420cfe471c6f8a31fc0aa176b710c36900aea (diff)
Update readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 23 insertions, 8 deletions
diff --git a/README.md b/README.md
index 5bd8c2f8..edc9196d 100644
--- a/README.md
+++ b/README.md
@@ -6,26 +6,41 @@
[![Screenshot](https://raw.githubusercontent.com/gcushen/hugo-academic/master/academic.png)](https://github.com/gcushen/hugo-academic/)
+## Getting Started
+
+The following two methods describe how to install in the cloud using your web browser and how to install on your PC using the Command Prompt/Terminal app.
+
+### Quick install using your web browser
+
+1. [Install Academic with Netlify](https://app.netlify.com/start/deploy?repository=https://github.com/sourcethemes/academic-kickstart)
+ * Netlify will provide you with a customizable URL to access your new site
+2. On GitHub, go to your newly created `academic-kickstart` repository and edit `config.toml` to personalize your site. Shortly after saving the file, your site will automatically update
+3. Read the [Quick Start Guide](https://sourcethemes.com/academic/docs/) to learn how to add Markdown content. For inspiration, refer to the [Markdown content](https://github.com/gcushen/hugo-academic/tree/master/exampleSite) which powers the [Demo](https://themes.gohugo.io/theme/academic/)
+
+### Install on your PC
+
Prerequisites:
* [Download and install Git](https://git-scm.com/downloads)
* [Download and install Hugo](https://gohugo.io/getting-started/installing/#quick-install)
-Easily create a website using the Academic framework by following these simple steps:
-
-1. Clone (or [Fork](https://github.com/sourcethemes/academic-kickstart#fork-destination-box)) this repository using Git:
+1. Clone (or [Fork](https://github.com/sourcethemes/academic-kickstart#fork-destination-box) or [download](https://github.com/sourcethemes/academic-kickstart/archive/master.zip)) the *Academic Kickstart* repository with Git:
git clone https://github.com/sourcethemes/academic-kickstart.git My_Website
+
+ *Note that if you forked Academic Kickstart, the above command should be edited to clone your fork.*
-2. Apply any updates to Academic (optional):
+2. Initialize the theme:
cd My_Website
- bash update_academic.sh
-
-3. View your new website (from within your `My_Website` folder):
+ git submodule update --init --recursive
+3. View your new website:
+
hugo server
-
+
+ Now you can go to [localhost:1313](http://localhost:1313) and your new Academic powered website should appear.
+
4. Read the [Quick Start Guide](https://sourcethemes.com/academic/docs/) to learn how to add Markdown content, customize your site, and deploy it.
## License