Browse Source

docs(readme): update getting started

Josh Habdas 1 year ago
parent
commit
fdee785d37
Signed by: Josh Habdas <jhabdas@protonmail.com> GPG Key ID: B148B31154C75A74
1 changed files with 7 additions and 7 deletions
  1. 7
    7
      README.md

+ 7
- 7
README.md View File

@@ -12,11 +12,11 @@
12 12
 
13 13
 ## About
14 14
 
15
-After Dark is a minimalist dark theme and website starter kit for use with the popular [Hugo](https://gohugo.io/) static content generator. It is an original work inspired by a memory of the joys of learning to code for the Web made to feel reminiscent of hobbiest websites created during the mid- to late-1990's. It is built to be approachable, extensible and fast. Welcome to [After Dark](https://git.habd.as/comfusion/after-dark/).
15
+After Dark is a minimalist dark theme and website starter kit for use with the popular [Hugo](https://gohugo.io/) static content generator. It is an original work inspired by a memory of the joys of learning to code for the Web made to feel reminiscent of hobbiest websites created during the mid- to late-1990's. It is built to be approachable, extensible and fast. Welcome to After Dark.
16 16
 
17 17
 ## Demo & Tutorial
18 18
 
19
-Visit [Hack Cabin](https://hackcabin.com) for a production example. Learn to recreate the site architecture with [step-by-step guide](https://go.habd.as/zero-to-http-2).
19
+Visit [Hack Cabin](https://hackcabin.com) for a production example. Learn to recreate the production site architecture with a [step-by-step guide](https://go.habd.as/zero-to-http-2).
20 20
 
21 21
 ## Features
22 22
 
@@ -57,23 +57,23 @@ After Dark requires a single dependency to operate. Before running the installat
57 57
 brew install hugo elinks
58 58
 ```
59 59
 
60
-With Hugo installed run the quick install script located in the theme's `bin/install` directory, or connect to the Internet and run the following to install After Dark remotely from the [NPM package](https://www.npmjs.com/packages/after-dark) registry:
60
+Then run the quick installer located in `bin/install`, or just paste this into a terminal and press <kbd>Enter</kbd>:
61 61
 
62 62
 ```shell
63 63
 wget -qO - https://git.habd.as/comfusion/after-dark/raw/branch/master/bin/install | sh
64 64
 ```
65 65
 
66
-Installation should complete in a matter of seconds. If you have `elinks` installed your new site [will open](https://git.habd.as/comfusion/after-dark/images/docs/feat-quick-installer.gif) automatically in a terminal browser with Hugo running in the background and available for immediate use.
66
+The quick installer will download the theme and any [preinstalled modules](#module-system) and should complete in a matter of seconds. If you have `elinks` installed your new site [will open automatically](https://git.habd.as/comfusion/after-dark/src/branch/master/images/docs/feat-quick-installer.gif) with a local preview and next steps.
67 67
 
68
-Use [`hugo new`](https://gohugo.io/commands/hugo_new/) to create content. For example, to create a new post enter `hugo new post/post-title.md`. Then run [`hugo server --buildDrafts`](https://gohugo.io/commands/hugo_server/) to see your content locally and watch for changes during editing.
68
+---
69 69
 
70
-To view your content online run the included `bin/preview` script from your site directory:
70
+To preview your site online at any time run the included `bin/preview` script from your After Dark installation directory:
71 71
 
72 72
 ```sh
73 73
 cd flying-toasters && ./themes/after-dark/bin/preview
74 74
 ```
75 75
 
76
-Preview starts a hugo server and connects it to [Serveo](https://serveo.net) using an SSH tunnel to expose your local server to the internet with end-to-end encryption. You must have an ssh server such as [dropbear](https://matt.ucc.asn.au/dropbear/dropbear.html) or [openssh](https://www.openssh.com) installed for this to work.
76
+Preview starts a [`hugo server`](https://gohugo.io/commands/hugo_server/) and connects it to [Serveo](https://serveo.net) to expose your website to the Internet using end-to-end encryption. You must have an ssh server such as [dropbear](https://matt.ucc.asn.au/dropbear/dropbear.html) or [openssh](https://www.openssh.com) installed on your system for the preview script to function.
77 77
 
78 78
 ## Customizing
79 79
 

Loading…
Cancel
Save