source-index

README

Installation • Usage • Build Status • Contributing • License

SourceIndex is a simple utility for generating index page for source code archives. Currently, we use SourceIndex for generating an index for EK Sources Repository.

Installation

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

go get github.com/essentialkaos/source-index

If you want update SourceIndex to latest stable release, do:

go get -u 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