X-Git-Url: https://git.madduck.net/code/vcsh.git/blobdiff_plain/807ddaaed8d86a117871c41895346f25f6f93890..f42f0554bb298bfa9ad4cc63c7c481cb55f38da7:/doc/vcsh.1.ronn diff --git a/doc/vcsh.1.ronn b/doc/vcsh.1.ronn index efb5ba5..038cc2b 100644 --- a/doc/vcsh.1.ronn +++ b/doc/vcsh.1.ronn @@ -207,9 +207,12 @@ but please let upstream know so we can ship them by default. ## DETAILED HOWTO AND FURTHER READING -Man pages are intended to be short and thus often useless to glean best -practices from. This software comes with a file called . It contains -various approaches to setting up and using vcsh. You can view the file it as +Manpages are often short and sometimes useless to glean best practices from. +While the author tried to avoid this in this case, manpages can not cover +detailed howtos. + +This software also comes with a file called . It contains various +approaches to setting up and using vcsh. You can view the file it as plain text or render it into various other formats via Markdown. On Debian-based systems, this file can be found in . @@ -229,8 +232,9 @@ None are known at this time, but reports and/or patches are more than welcome. ## INTEROPERABILITY -If you rely on `git submodule`, use `git` 1.7.12 or later. Earlier versions -do not clean internal variables properly before descending into a submodule. +If you rely on `git submodule` use `git` 1.7.12 or later. Earlier versions +do not clean internal variables properly before descending into submodules, +resulting in unhappy end users. ## HISTORY