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-11-23 04:41:58 +0300
committerGeorge Cushen <gcushen@users.noreply.github.com>2017-11-23 04:41:58 +0300
commited6d2ce46155caa595c43aa31925c21f20a9cee1 (patch)
tree095e53a452682557e460b6fbe0905be2933bc225 /README.md
parent6666b40fb120edb31bafb5bb86dfa8cfbf0020bb (diff)
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 37 insertions, 2 deletions
diff --git a/README.md b/README.md
index 270a2dcf..5bd8c2f8 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,37 @@
-# academic-kickstart
-Easily create a website using Academic
+# Academic Kickstart
+
+**Academic** is a framework to help you create a beautiful website quickly. Perfect for personal, student, or academic websites. [Check out the latest demo](https://themes.gohugo.io/theme/academic/) of what you'll get in less than 10 minutes or [view the documentation](https://sourcethemes.com/academic/docs/).
+
+**Academic Kickstart** provides a minimal template to kickstart your new website by following the simple steps below.
+
+[![Screenshot](https://raw.githubusercontent.com/gcushen/hugo-academic/master/academic.png)](https://github.com/gcushen/hugo-academic/)
+
+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:
+
+ git clone https://github.com/sourcethemes/academic-kickstart.git My_Website
+
+2. Apply any updates to Academic (optional):
+
+ cd My_Website
+ bash update_academic.sh
+
+3. View your new website (from within your `My_Website` folder):
+
+ hugo server
+
+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
+
+Copyright 2017 [George Cushen](https://georgecushen.com).
+
+Released under the [MIT](https://github.com/sourcethemes/academic-kickstart/blob/master/LICENSE.md) license.
+
+[![Analytics](https://ga-beacon.appspot.com/UA-78646709-2/academic-kickstart/readme?pixel)](https://github.com/igrigorik/ga-beacon)