Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/leonstafford/accessible-minimalism-hugo-theme.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLeon Stafford <me@ljs.dev>2020-09-10 06:19:43 +0300
committerLeon Stafford <me@ljs.dev>2020-09-10 06:19:43 +0300
commit7aa52131aa02ae72c4371c737f874d2d2df9ad21 (patch)
tree6705aa025fa1dd2e2a82d6d5335177a8d628ba42 /README.md
parentaf8efdcd5efadc73990c112fb3693dfc6e66da54 (diff)
flesh out readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1c362a1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# Accessible Minimalism Hugo Theme
+
+Minimalist Hugo theme with a penchant for accessibility
+
+## Project aims
+
+ - HTML 1 and HTML 5 valid code
+ - minimal bloat in the generated markup
+ - focus on accessibility
+ - semantic, minimal markup for screen readers
+ - minimal CSS for high contrast viewing
+ - easy to read source code
+ - minimal config required to get started and use in Hugo
+ - RSS subscription support
+ - mobile-last development
+
+## Who is this for?
+
+This aims at users who care more about content and inclusivity than dancing baby
+ GIFs or whatever the 2020 equivalent is.
+
+The early web was great for content, unburdened by MBs of JavaScript or CSS.
+ RSS feeds allowed users to pull your content on demand vs being forced into
+ giving you space in their precious inbox or following your social-ills.
+
+## Getting started
+
+1. In your Hugo site's root, clone this repo to your `themes` dir:
+
+`git clone --depth 1 https://github.com/leonstafford/accessible-minimalism-hugo-theme themes/accessible-minimalism`
+
+2. Copy the `config.toml` file from the exampleSite directory inside this repository to your site root:
+
+`cp themes/accessible-minimalism/exampleSite/config.toml .`
+
+
+### License
+
+[The Unlicense](https://unlicense.org) - do whatever you like with this code.