diff options
author | Zack Scholl <zack.scholl@gmail.com> | 2017-11-02 21:29:48 +0300 |
---|---|---|
committer | Zack Scholl <zack.scholl@gmail.com> | 2017-11-02 21:29:48 +0300 |
commit | b1aa0d5008435e96518979812560777c32021fb6 (patch) | |
tree | b42ab49cc5c5221e0a4f9fa99ab3ba6731881234 | |
parent | 9698a5c89df59ecf4ef3fbb6089630c776370d53 (diff) |
Add README
-rwxr-xr-x | README.md | 24 | ||||
-rwxr-xr-x | theme.toml | 16 |
2 files changed, 32 insertions, 8 deletions
diff --git a/README.md b/README.md new file mode 100755 index 0000000..9393f92 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +portcullis
+==========
+
+This is a very simple, minimalistic, responsive theme that I'm using for my personal website. It has some neat features like captioning images, but its best quality is its lack of features (no jQuery, no huge image banners, no post previews, no word counts, etc.).
+
+# Using
+
+```
+git clone https://github.com/schollz/portcullis.git themes/portcullis
+hugo server -t portcullis
+```
+
+# Configuration
+
+You can add your Twitter handle to the configuration file for people can comment you via Direct Messages or Tweets. For example,
+
+```
+[params]
+ twitter = "yakczar"
+```
+
+# License
+
+MIT
\ No newline at end of file @@ -1,18 +1,18 @@ # theme.toml template for a Hugo theme # See https://github.com/gohugoio/hugoThemes#themetoml for an example -name = "Best" +name = "portcullis" license = "MIT" -licenselink = "https://github.com/yourname/yourtheme/blob/master/LICENSE.md" -description = "" -homepage = "http://example.com/" -tags = [] -features = [] +licenselink = "https://github.com/schollz/portcullis/blob/master/LICENSE.md" +description = "A simple, elegant, mobile-ready, minimalistic theme" +homepage = "https://github.com/schollz/portcullis" +tags = ["minimal","mobile","responsive","elegant"] +features = ["image captioning"] min_version = "0.27.1" [author] - name = "" - homepage = "" + name = "Zack Scholl" + homepage = "https://schollz.github.io/" # If porting an existing theme [original] |