(drak)
2014-02-10: Restructure Readme: First Mission Statement, then Installation and Restructure Readme: First Mission Statement, then Installation and Usage, then Features and finally options.
diff --git a/README.txt b/README.txt --- a/README.txt +++ b/README.txt @@ -6,15 +6,61 @@ Get it via `hg clone http://draketo.de/p With hg site you can say goodbye to vendor lock-in. -Description ------------ +Mission Statement +----------------- -The goal of hg site is sharing code over commodity servers which only +The goal of hg site is to enable convenient sharing of code over commodity servers which only offer FTP access and statically served files, while providing the same information as hg serve and full solutions like bitbucket and gitorious (naturally without the interactivity, but you can always clone the repo to interact). + +Installation +------------ + +* Clone this repo. + `hg clone http://draketo.de/proj/hgsite/` +* add this to the `[extensions]` section in your `~/.hgrc` + `site = path/to/staticsite.py` + if you have no such section, just add a line with content `[extensions]`. The extensions-section is below that line. + + +Usage +----- + +Create and Upload your Site: `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. + +If you want to make this easier, add a path and an alias to your .hg/hgrc: + + [paths] + ftp = ftps://user:password@ftp.host.tld/path/to/dir + [alias] + pushsite = push --sitename "sitename" ftp + +Then just use `hg pushsite` to upload. + +To upload the site when you push it anywhere, you can use a hook in .hg/hgrc: + + [hooks] + post-push = hg site -n site -u user:password@ftp.host.tld/path/to/dir + + +Features +-------- + +- shows the history, branches, tags and bookmarks. +- shows bugs tracked via the [b-extension][]. +- shows the readme. +- shows forks which are defined as paths in `.hg/hgrc` - from any source hg supports. +- uploads only hanged 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://`). +- static site (no vulnerabilities, little dependencies, high performance). + Thanks to the static http support of [Mercurial][], the clone and browse URLs are the same, so you can look at the site with your webbrowser or clone the repository with Mercurial using the same URL. @@ -26,56 +72,9 @@ tracks repositories from any source for incoming and outgoing changes. And since the bugtracking happens via the b-extension, your bugtracking follows your code wherever you go. - -Features --------- - -- shows the history, branches, tags and bookmarks. -- shows bugs tracked via the [b-extension][]. -- shows the readme. -- shows forks which are defined as paths in `.hg/hgrc` - from any source hg supports. -- uploads only hanged 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://`). -- static site (no vulnerabilities, little dependencies, high performance). - [b-extension]: http://mercurial.selenic.com/wiki/bExtension "Distributed Bug Tracking: Get bugs resolved, not organized" -Installation ------------- - -* Clone this repo. - hg clone http://draketo.de/proj/hgsite/ -* 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. - With -f it is reuploaded completely, - 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: - - [paths] - ftp = ftps://user:password@ftp.host.tld/path/to/dir - [alias] - pushsite = push --sitename "sitename" ftp - -Then just use `hg pushsite` to upload. - -To upload the site when you push it anywhere, you can use a hook in .hg/hgrc. This is what I use: - - [hooks] - post-push = hg site -n site -u user:password@ftp.host.tld/path/to/dir - - Basic Options -------------