From 2e84cb9eb5c8ab12c9703c41a89c4379f84b6573 Mon Sep 17 00:00:00 2001 From: George Cushen Date: Fri, 8 Dec 2017 00:34:33 +0000 Subject: [PATCH] Update readme --- README.md | 31 +++++++++++++++++++++++-------- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5bd8c2f..edc9196 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