diff --git a/docs/core/usage.md b/docs/core/usage.md index fb26671..5c065e7 100644 --- a/docs/core/usage.md +++ b/docs/core/usage.md @@ -117,6 +117,7 @@ tweego -d -o example5.twee example5.html Tweego allows you to specify an arbitrary number of files and directories on the command line for processing. In addition to those manually specified, it will recursively search all directories encountered looking for additional files and directories to process. Generally, this means that you only have to specify the base source directory of your project and Tweego will find all of its files automatically. + ### Supported File Extensions Tweego only processes files with the following extensions: diff --git a/docs/introduction.md b/docs/introduction.md index ec5481f..28ffc37 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -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. + +
Note: +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 at its source code repository. +