diff options
| -rw-r--r-- | README.md | 31 | ||||
| -rw-r--r-- | description | 2 | ||||
| -rw-r--r-- | long-description | 3 |
3 files changed, 34 insertions, 2 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..b8743fd --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# gistatic + +Static Git repository generator + +Generate static HTML pages for online hosting of a repository with +static files only. + +## Usage + +Generate static HTML website for Git repository: + +```shell +$ cd path/to/git/repo/ +$ gistatic -o public/ +``` + +## Installation + +Get the latest tarball and install it: + +``` +wget https://euandreh.xyz/gistatic/tarballs/gistatic-main.tar.gz +tar xvf gistatic-main.tar.gz +cd gistatic-main/ +make +[sudo] make install +``` + +## Documentation + +Documentation available via installed manpages, also available online: [`gistatic.1`](gistatic.1.html). diff --git a/description b/description index 4c28ea5..7c91fe6 100644 --- a/description +++ b/description @@ -1 +1 @@ -FIXME
\ No newline at end of file +Static Git repository generator diff --git a/long-description b/long-description index 4c28ea5..60f64e4 100644 --- a/long-description +++ b/long-description @@ -1 +1,2 @@ -FIXME
\ No newline at end of file +Generate static HTML pages for online hosting of a repository with +static files only. |