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] Reworked intro and cleanup.

Browse source
This commit is contained in:
Thomas M. Edwards 2020-03-03 02:30:40 -06:00
parent cba4051ee1
commit d08ed3a980
4 changed files with 59 additions and 50 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/introduction.md
View file

@ -3,9 +3,9 @@
************************************************************************************************ -->
<h1 id="introduction">Introduction</h1>
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/).
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/).
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.
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"><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>.