# csb

csb is a static source code hosting tool. The rationale behind the design is
outlined [here][csb].

## Installation

Build requirements:
 * [go][golang]
 * uuencode
 * standard Unix tools

On a \*nix system, installation is as simple as:

`make install`

The makefile installs to /usr/ by default, but respects the PREFIX environment
variable.

## Usage

To create a new hosting site, run `csb init`. This will lay out the basic
directory structure and add all needed defaults.

The main index for the site is a markdown file at content/index.md, and the
template for it is templates/frontindex.tmpl.

To add a new repository use `csb addrepo`. This will make a new directory in
content/ with the name of repository, with its own index.md (which uses the
project.tmpl template).

Building is `csb build`, which outputs by default into the public/ directory.

Help is provided through `csb help` or using the `-h` option on individual
subcommands.

[csb]: (https://code.valturial.net/csb)
[golang]: (https://golang.org)