archives/tweego
2
0
Fork 0
mirror of https://github.com/tmedwards/tweego.git synced 2025-07-06 06:30:31 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

[Docs] Add mini description of Tweego to the intro.

Browse source
This commit is contained in:
Thomas M. Edwards 2020-03-02 18:00:48 -06:00
parent 1cfd23004f
commit cba4051ee1
2 changed files with 6 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/introduction.md
View file

@ -5,4 +5,8 @@
This documentation is a reference for [Tweego](http://www.motoslave.net/tweego/), a free (gratis and libre) command line compiler for [Twine/Twee](http://twinery.org/) story formats, written in [Go](http://golang.org/).
If you believe that you've found a bug in Tweego or simply wish to make a suggestion, you may do so by [creating a new issue](https://github.com/tmedwards/tweego/issues) at its [source code repository](https://github.com/tmedwards/tweego).
Tweego is a [command line program](https://en.wikipedia.org/wiki/Command-line_interface) that compiles a Twine game from loose, usually text, files. Passages are defined within Twee files—see: [Twee Notation](#twee-notation) and [Twine Cookbook: *What is Twee?*](http://twinery.org/cookbook/terms/terms_twee.html)—though Tweego [supports many types of files](#usage-file-and-directory-handling-supported-extensions). This allows you to write your game using your favorite text editor, rather than the Twine IDE, and compile it into an `.html` file with Tweego.
<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>