INSTALL

   1
   2                 Cogito installation
   3
   4 Normally you can just do "make" followed by "make install", and that
   5 will install the Cogito scripts in your own ~/bin/ directory.
   6 If you want to do a global install, you can do
   7
   8         make prefix=/usr install
   9
  10 (or prefix=/usr/local, of course).  Some day somebody may send me a RPM
  11 spec file or something, and you can do "make rpm" or whatever.
  12
  13 You can place local settings in config.mak and the Makefile will include
  14 them.  Note that config.mak is not distributed; the name is reserved for
  15 local settings.
  16
  17
  18 Issues of note:
  19
  20  - Cogito normally installs a helper script wrapper called "cg", which
  21    might conflict with another similarly named program.
  22
  23    Tough.  The wrapper is however completely optional and everything
  24    will work fine if you delete it and just directly use the individual
  25    tools.
  26
  27  - Cogito needs a pre-existing Git installation. It is recommended to
  28    use at least version 1.4.4 or newer (provided that Git stays
  29    backwards compatible). Watch this spot if you update Cogito to see
  30    the possible new minimal version requirement. You can get Git at
  31
  32         http://www.kernel.org/pub/software/scm/git
  33
  34  - By default, separate documentation (manpages, text, HTML) is not built
  35    since it requires asciidoc and xmlto, and those tools are not so common.
  36    You can build it by "make doc" and install it later by "make install-doc"
  37    in the project root, or you can build directly in the "Documentation/"
  38    subdirectory, where you can also choose to build only documentation in
  39    particular format. See Documentation/Makefile for further details.
  40
  41    Note that the documentation is always available by
  42
  43         cg-help cmdname
  44
  45    or "cg-cmdname --help" and it is _exactly_ the same content as what you
  46    will get by building separate documentation - the only extra you would
  47    get is a page about 'cogito' itself, containing some general blather.