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

github.com/AngeloStavrow/indigo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAngelo Stavrow <angelo@fogcreek.com>2018-09-30 20:18:48 +0300
committerAngelo Stavrow <angelo@fogcreek.com>2018-09-30 20:18:48 +0300
commit3ee2d17ad565d030051fd269b5381a15831137af (patch)
treecb4c2cf5014abf32cc9f7f9989f1d0b4b0a61fc4 /README.md
parenta8b739f0ab280400945245e8b28b1823631950cf (diff)
Add README (closes #6)
Diffstat (limited to 'README.md')
-rw-r--r--README.md69
1 files changed, 69 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cb71d51
--- /dev/null
+++ b/README.md
@@ -0,0 +1,69 @@
+# Indigo Theme
+
+Indigo is a lightweight, responsive, typography-first theme for Hugo, marked up with [microformats2](http://microformats.org) for extra [IndieWeb](https://indieweb.org) goodness, including [IndieAuth](https://indieauth.com).
+
+## Getting Started
+
+These instructions will get you a copy of the project up and running on your local machine for setup and testing purposes. See deployment for notes on how to deploy the project on a live system.
+
+### Prerequisites
+
+Some portions of the templates use variable rewriting, introduced in Hugo 0.48, so you'll need to make sure you're running at least this version. You can check what version you're running with
+
+```
+$ hugo version
+```
+
+Follow the [upgrade instructions on the Hugo website](https://gohugo.io/getting-started/installing/#upgrade-hugo) if necessary.
+
+### Installing
+
+Follow the [theme-installation instructions on the Hugo website](https://gohugo.io/themes/installing-and-using-themes/#install-a-single-theme); the URL you'll want to use is
+
+```
+https://github.com/AngeloStavrow/indigo.git
+```
+
+### Setup
+
+There's a sample config.toml file in the root of the indigo theme directory (`config.toml.example`); copy it to the root of your Hugo site, and rename it to `config.toml` _after_ you've made a backup of your current config.toml file (if any).
+
+Set up the parameters in the config file, especially those in the social and `params.indieWeb` section. Social identifiers that you leave out will not be added to the footer of the site.
+
+You can configure the theme to show info about the author; by default, this information is shown; if you'd prefer to leave it out, set `ShowBio` to `false`.
+
+## Deployment
+
+You can add a line to your **config.toml** file to set this theme as the default:
+
+```
+theme: indigo
+```
+
+## Contributing
+
+Please read [CONTRIBUTING.md](https://github.com/AngeloStavrow/indigo/blob/master/CONTRIBUTING.md) for details on the code of conduct, and the process for submitting pull requests.
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/AngeloStavrow/indigo/tags).
+
+## Authors
+
+* **Angelo Stavrow** - *Initial work* - [AngeloStavrow](https://github.com/AngeloStavrow) on GitHub
+
+See also the list of [contributors](https://github.com/AngeloStavrow/indigo/contributors) who participated in this project.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
+
+## Acknowledgments
+
+The following open fonts are used in this theme:
+
+* [Fira Sans](https://bboxtype.com/typefaces/FiraSans/#!layout=specimen) for heading text
+* [Charter](https://practicaltypography.com/charter.html) for body text
+* [Fira Code](https://github.com/tonsky/FiraCode) for monospaced text
+
+Licenses are included in the theme’s `static/fonts` folder. \ No newline at end of file