(Arne Babenhauserheide)
2014-02-09: readme: notes readme: notes
diff --git a/README.txt b/README.txt --- a/README.txt +++ b/README.txt @@ -34,7 +34,7 @@ Features - shows forks defined as paths in `.hg/hgrc` - from any source hg supports - uploads only changed files (based on the time they were last modified), so uploads can be reasonably fast. -- Supports FTP and FTPs. Use the latter if you can (just use URLs starting with `ftps://`) +- Supports FTP and FTPS. Use the latter if you can (just use URLs starting with `ftps://`) - static site (no vulnerabilities, little dependencies, high performance) [b-extension]: http://mercurial.selenic.com/wiki/bExtension "Distributed Bug Tracking: Get bugs resolved, not organized" @@ -43,20 +43,21 @@ were last modified), so uploads can be r Installation ------------ -* Clone this repo. +* Clone this repo. hg clone http://draketo.de/proj/hgsite/ -* add this to the [extensions] section in your ~/.hgrc - site = path/to/staticsite.py +* add this to the [extensions] section in your ~/.hgrc + site = path/to/staticsite.py if you have no [extensions] section, add it. Usage ----- -$ hg push [-f] --sitename "sitename" ftps://user:password@ftp.host.tld/path/to/dir -→ that’s how this site gets created. + $ hg push [-f] --sitename "sitename" ftps://user:password@ftp.host.tld/path/to/dir + +→ that’s how this site gets created. With -f it is reuploaded completely, - otherwise only the changes get uploaded. + otherwise only the changes get uploaded. defining the ftp://… or ftps://… in [paths] in .hg/hgrc works. If you want to make this easier, add an alias to your .hg/hgrc: @@ -74,26 +75,26 @@ To upload the site when you push it anyw post-push = hg site -n site -u user:password@ftp.host.tld/path/to/dir -$ hg site --help -hg site [options] [folder] - -Create a static copy of the repository and/or upload it to an FTP server. - -use "hg help -e site" to show help for the site extension - -options: - - -n --name VALUE the repo name. Default: folder or last segment of the - repo-path. - -u --upload VALUE upload the repo to the given ftp host. Format: - user:password@host/path/to/dir - -f --force force recreating all commit files. Slow. - -s --screenstyle VALUE use a custom stylesheet for display on screen - -p --printstyle VALUE use a custom stylesheet for printing - --mq operate on patch repository - -use "hg -v help site" to show global options - + $ hg site --help + hg site [options] [folder] + + Create a static copy of the repository and/or upload it to an FTP server. + + use "hg help -e site" to show help for the site extension + + options: + + -n --name VALUE the repo name. Default: folder or last segment of the + repo-path. + -u --upload VALUE upload the repo to the given ftp host. Format: + user:password@host/path/to/dir + -f --force force recreating all commit files. Slow. + -s --screenstyle VALUE use a custom stylesheet for display on screen + -p --printstyle VALUE use a custom stylesheet for printing + --mq operate on patch repository + + use "hg -v help site" to show global options + Customization ------------- @@ -102,13 +103,9 @@ To change the appearance of your site, c -Copyright ---------- +Notes +----- Copyright 2012 till 2014 Arne Babenhauserheide, Licensed under GPLv2 or later. - -Related -------- - -- git2html → http://hssl.cs.jhu.edu/~neal/git2html/ +Related: git2html → http://hssl.cs.jhu.edu/~neal/git2html/