mirror of
https://github.com/tmedwards/tweego.git
synced 2025-07-06 06:30:31 -04:00
16 lines
1.5 KiB
Markdown
16 lines
1.5 KiB
Markdown
<!-- ***********************************************************************************************
|
|
Introduction
|
|
************************************************************************************************ -->
|
|
<h1 id="introduction">Introduction</h1>
|
|
|
|
This documentation is a reference for [Tweego](http://www.motoslave.net/tweego/), a free (gratis and libre) [command line interface](https://en.wikipedia.org/wiki/Command-line_interface) compiler for [Twine](http://twinery.org/) projects, written in [Go](http://golang.org/).
|
|
|
|
Why use Tweego? Tweego lets you write Twine projects using your favorite text editor, rather than the [Twine software](http://twinery.org/). You write passages in plain text files using the [Twee notation](#twee-notation) across as few or as many files as you choose, which can make working, and collaborating, on Twine projects faster and easier. When you're ready to publish or test, you simply compile all your project files into an `.html` file with Tweego.
|
|
|
|
<p role="note" class="tip"><b>Tip:</b>
|
|
This document is a single page, so you may use your browser's find-in-page functionality—<kbd>CTRL</kbd>+<kbd>F</kbd> or <kbd>F3</kbd>—to search for specific terms.
|
|
</p>
|
|
|
|
<p role="note"><b>Note:</b>
|
|
If you believe that you've found a bug in Tweego, or simply wish to make a suggestion, you may do so by <a href="https://github.com/tmedwards/tweego/issues">creating a new issue</a> at its <a href="https://github.com/tmedwards/tweego">source code repository</a>.
|
|
</p>
|