tweego

README

Tweego

Tweego is a free (gratis and libre) command line compiler for Twine/Twee story formats, written in Go.

By: @tmedwards.

See Tweego's documentation for information on how to set it up and use it.

Tweego has a Trello board, Tweego TODO. Feel free to comment.

INSTALLATION

You may either download one of the precompiled binaries from Tweego's website, which are available in both 32- and 64-bit versions for multiple operating systems, or build Tweego from source (see BUILDING FROM SOURCE below).

BUILDING FROM SOURCE

If you want to build Tweego from scratch, rather than grabbing one of the precompiled binaries off of its website, then these instructions are for you.

Tweego is written in the Go programming language, so you'll need to install it, if you don't already have it. Additionally, to retrieve Go packages—like Tweego and its dependencies—from source control repositories, you'll need to install both Mercurial and Git.

1. Download and install the Go programming language (want ≥v1.7)
2. Download and install the Mercurial source control management tool
3. Download and install the Git source control management tool

Once everything is installed and setup, you'll need to fetch and compile the Tweego source code and its dependencies. This may easily be done by running the following command:

go install bitbucket.org/tmedwards/tweego

That should download Tweego and its dependencies, compile them, and install them to the appropriate GOPATH directories.

Assuming that completed with no errors, your compiled Tweego binary will be in your GOPATH's bin directory. To run Tweego you'll need to either have added your GOPATH bin to your PATH environment variable—this was likely done for you automatically during the installation of Go—or copy the binary to an existing directory within your PATH.

See Tweego's documentation for information on how to set it up and use it.