From 64eae9571ed32077149f7794b1eb65856fef8e58 Mon Sep 17 00:00:00 2001 From: George Cushen Date: Fri, 24 Nov 2017 02:25:31 +0000 Subject: [PATCH] readme: Improve installation method --- README.md | 40 +++++++++++++++++++++++++++------------- 1 file changed, 27 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 3f092ffd..07e58d42 100644 --- a/README.md +++ b/README.md @@ -33,30 +33,44 @@ Academic is available in different color themes and font themes. ## Getting Started -1. [Install Hugo](https://georgecushen.com/create-your-website-with-hugo/#installing-hugo) and create a new website by typing the following commands in your *Terminal* or *Command Prompt* app: +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. - hugo new site my_website - cd my_website +### Quick install using your web browser -2. Install Academic with [git](https://help.github.com/articles/set-up-git/): +1. [Fork](https://github.com/sourcethemes/academic-kickstart#fork-destination-box) the *Academic Kickstart* repository on GitHub - git clone https://github.com/gcushen/hugo-academic.git themes/academic +2. [Login to Netlify using your GitHub account](https://app.netlify.com) + * Click *Create a new site* + * Follow the steps to connect to GitHub, select your new `academic-kickstart` repository, keep the default options and click *Deploy Site* + * Netlify will automatically provide you with a URL to access your new site - Or alternatively, [download Academic](https://github.com/gcushen/hugo-academic/archive/master.zip) and extract it into a `themes/academic` folder within your Hugo website. +3. On GitHub, go to your `academic-kickstart` repository and edit `config.toml` to personalize your site. Shortly after saving the file, your site will automatically update -3. If you are creating a new website, copy the contents of the `exampleSite` folder to your website root folder, overwriting existing files if necessary. The `exampleSite` folder contains an example config file and content to help you get started. +4. 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/) - cp -av themes/academic/exampleSite/* . +### Install on your PC -4. Start the Hugo server from your website root folder: +Prerequisites: - hugo server +* [Download and install Git](https://git-scm.com/downloads) +* [Download and install Hugo](https://gohugo.io/getting-started/installing/#quick-install) + +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 already forked Academic Kickstart, the above command should be changed to clone your fork.* + +2. View your new website: + + cd My_Website + hugo server Now you can go to [localhost:1313](http://localhost:1313) and your new Academic powered website should appear. + +3. Read the [Quick Start Guide](https://sourcethemes.com/academic/docs/) to learn how to add Markdown content, customize your site, and deploy it. 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/) -5. [Customize your website](https://sourcethemes.com/academic/post/getting-started/#getting-started) and [add your content](https://sourcethemes.com/academic/post/managing-content/) by referring to the Academic documentation - -6. Build your site by running the `hugo` command. Then [host it for free using Github Pages](https://georgecushen.com/create-your-website-with-hugo/). Or alternatively, copy the generated `public/` directory (by FTP, Rsync, etc.) to your production web server (such as your university's hosting service). +4. Build your site by running the `hugo` command. Then [host it for free using Github Pages](https://georgecushen.com/create-your-website-with-hugo/) or Netlify (refer to above section). Alternatively, copy the generated `public/` directory (by FTP, Rsync, etc.) to your production web server (such as your university's hosting service). ## Updating