grim/hgkeeper-theme

Add a readme
draft
2020-03-22, Gary Kramlich
43f92fc36d1b
Parents 15aa4b1f3868
Children 60a968e5fb03
Add a readme
1 files changed, 29 insertions(+), 0 deletions(-)
  • +29 -0
    README.md
    • --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/README.md Sun Mar 22 07:02:21 2020 -0500
    @@ -0,0 +1,29 @@
    +# HGKeeper Theme
    +
    +This repository contains the default theme for
    +[HGKeeper](https://keep.imfreedom.org/grim/hgkeeper). It has been designed to
    +feel like a modern hosting provider.
    +
    +# Prerequisites
    +
    +This theme depends the
    +[hgkeeper-ext](https://keep.imfreedom.org/grim/hgkeeper-ext) extension for some
    +additional features.
    +
    +# Installation
    +
    +Installation is pretty straight forward. Just clone or extract this repository
    +to somewhere on your machine and update your `hgrc` file with the following
    +items.
    +
    +```
    +[web]
    +templates = <path-where-you-extracted-this-repo-to>/templates
    +style = hgkeeper
    +```
    +
    +This could be any `hgrc` file, the user specific one at `~/.hgrc`, a
    +repo specific one in `.hg/hgrc`, or an `hgrc` for an hgweb setup.
    +
    +Once your `hgrc` is setup, you should be good to go!
    +