README.md

Installation • Usage • Build Status • Contributing • License

SourceIndex is a simple utility for generating index page for source code archives.

Installation

To build the SourceIndex from scratch, make sure you have a working Go 1.17+ workspace (instructions), then:

go install github.com/essentialkaos/source-index

Command-line completion

You can generate completion for bash, zsh or fish shell.

Bash:

sudo source-index --completion=bash 1> /etc/bash_completion.d/source-index

ZSH:

sudo source-index --completion=zsh 1> /usr/share/zsh/site-functions/source-index

Fish:

sudo source-index --completion=fish 1> /usr/share/fish/vendor_completions.d/source-index.fish

Usage

Usage: source-index {options} dir

Options

  --output, -o file      Output file (index.html by default)
  --template, -t file    Template (template.tpl by default)
  --no-color, -nc        Disable colors in output
  --help, -h             Show this help message
  --version, -v          Show version

Build Status

Branch	Status
master
develop

Contributing

Before contributing to this project please read our Contributing Guidelines.

License

Apache License, Version 2.0