|
| 1 | +# Academic Kickstart |
| 2 | + |
| 3 | +**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/). |
| 4 | + |
| 5 | +**Academic Kickstart** provides a minimal template to kickstart your new website by following the simple steps below. |
| 6 | + |
| 7 | +[](https://github.com/gcushen/hugo-academic/) |
| 8 | + |
| 9 | +## Getting Started |
| 10 | + |
| 11 | +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. |
| 12 | + |
| 13 | +### Quick install using your web browser |
| 14 | + |
| 15 | +1. [Install Academic with Netlify](https://app.netlify.com/start/deploy?repository=https://github.com/sourcethemes/academic-kickstart) |
| 16 | + * Netlify will provide you with a customizable URL to access your new site |
| 17 | +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 |
| 18 | +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/) |
| 19 | + |
| 20 | +### Install on your PC |
| 21 | + |
| 22 | +Prerequisites: |
| 23 | + |
| 24 | +* [Download and install Git](https://git-scm.com/downloads) |
| 25 | +* [Download and install Hugo](https://gohugo.io/getting-started/installing/#quick-install) |
| 26 | + |
| 27 | +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: |
| 28 | + |
| 29 | + git clone https://github.com/sourcethemes/academic-kickstart.git My_Website |
| 30 | + |
| 31 | + *Note that if you forked Academic Kickstart, the above command should be edited to clone your fork.* |
| 32 | + |
| 33 | +2. Initialize the theme: |
| 34 | + |
| 35 | + cd My_Website |
| 36 | + git submodule update --init --recursive |
| 37 | + |
| 38 | +3. View your new website: |
| 39 | + |
| 40 | + hugo server |
| 41 | + |
| 42 | + Now you can go to [localhost:1313](http://localhost:1313) and your new Academic powered website should appear. |
| 43 | + |
| 44 | +4. Read the [Quick Start Guide](https://sourcethemes.com/academic/docs/) to learn how to add Markdown content, customize your site, and deploy it. |
| 45 | + |
| 46 | +## License |
| 47 | + |
| 48 | +Copyright 2017 [George Cushen](https://georgecushen.com). |
| 49 | + |
| 50 | +Released under the [MIT](https://github.com/sourcethemes/academic-kickstart/blob/master/LICENSE.md) license. |
| 51 | + |
| 52 | +[](https://github.com/igrigorik/ga-beacon) |
0 commit comments