avocet

README

Avocet Tools

Avocet Editors provides a series of open source command-line tools for technical writers, fiction writers, and conlangers. These tools are written in Go and intended for use on Unix-like operating systems, such as Linux and FreeBSD. They may also work on Windows under WSL and macOS, but are presently not tested for these platforms.

Installation

Avocet Tools relies on Doit to manage the development and installation processes. This is a Python tool similar to GNU Make and SCons in its functionality.

1. Clone the repository:

   $ git clone git@gitlab.com/kennethpjdyer/avocet
   $ cd avocet/
   

2. Install dependencies:

   $ go mod tidy
   $ go mod vendor
   

3. Install the avocet command:

   $ go install ./cmd/avocet
   

4. Install the remaining Avocet Tools:

   $ avocet install
   

Usage

• avocet

avocet

The avocet command provides version and build information as well as a list of the installed tools and their function.

$ avocet

The development statuses are as follows:

Status	Description
Design	The tool is in the design phase. Requisite functions are in development, no command is yet available.
Development	The tool is under active development and should not be used.
Alpha	The tool is in a reasonably complete state, but should be used with caution as not all features may work reliably.
Beta	The tool is ready for testing by non-developers.
Stable	The tool is considered stable and ready for use.