From d08ed3a98069f2aeee116b1beb5f5873a4daf76b Mon Sep 17 00:00:00 2001 From: "Thomas M. Edwards" Date: Tue, 3 Mar 2020 02:30:40 -0600 Subject: [PATCH] [Docs] Reworked intro and cleanup. --- docs/core/faq-and-tips.md | 4 +- docs/core/usage.md | 98 +++++++++++++++++++++------------------ docs/introduction.md | 4 +- docs/table-of-contents.md | 3 +- 4 files changed, 59 insertions(+), 50 deletions(-) diff --git a/docs/core/faq-and-tips.md b/docs/core/faq-and-tips.md index 7b8770d..c28d7ac 100644 --- a/docs/core/faq-and-tips.md +++ b/docs/core/faq-and-tips.md @@ -5,7 +5,9 @@ This is a collection of tips, from how to avoid pitfalls to best practices. -Suggestions for new entries may be submitted by [creating a new issue](https://github.com/tmedwards/tweego/issues) at Tweego's [source code repository](https://github.com/tmedwards/tweego). **NOTE:** Acceptance of submissions ***is not*** guaranteed. +

Note: +Suggestions for new entries may be submitted by creating a new issue at Tweego's source code repository—though acceptance of submissions is not guaranteed. +

- -## Basic Examples + +## Supported Files -Compile example_1.twee as example_1.html with the default story format: +Tweego supports various types of files for use in projects. File types are recognized by filename extension, so all files ***must*** have an extension. -``` -tweego -o example_1.html example_1.twee -``` - -Compile all files in example_directory_2 as example_2.html with the default story format: - -``` -tweego -o example_2.html example_directory_2 -``` - -Compile example_3.twee as example_3.html with the story format snowman: - -``` -tweego -f snowman -o example_3.html example_3.twee -``` - -Compile all files in example_directory_4 as example_4.html with the default story format while also bundling all files in modules_directory_4 into the <head> element of the compiled HTML: - -``` -tweego -o example_4.html -m modules_directory_4 example_directory_4 -``` - -Decompile example_5.html as example_5.twee: - -``` -tweego -d -o example5.twee example5.html -``` - - - - -## File & Directory Handling - -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: +The following extensions are supported:
.tw, .twee
@@ -167,3 +127,49 @@ Tweego only processes files with the following extensions:

+ + + + +## File & Directory Handling + +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. + + + + +## Basic Examples + +Compile example_1.twee as example_1.html with the default story format: + +``` +tweego -o example_1.html example_1.twee +``` + +Compile all files in example_directory_2 as example_2.html with the default story format: + +``` +tweego -o example_2.html example_directory_2 +``` + +Compile example_3.twee as example_3.html with the story format snowman: + +``` +tweego -f snowman -o example_3.html example_3.twee +``` + +Compile all files in example_directory_4 as example_4.html with the default story format while also bundling all files in modules_directory_4 into the <head> element of the compiled HTML: + +``` +tweego -o example_4.html -m modules_directory_4 example_directory_4 +``` + +Decompile example_5.html as example_5.twee: + +``` +tweego -d -o example5.twee example5.html +``` diff --git a/docs/introduction.md b/docs/introduction.md index 28ffc37..6408f26 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -3,9 +3,9 @@ ************************************************************************************************ -->

Introduction

-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.

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. diff --git a/docs/table-of-contents.md b/docs/table-of-contents.md index 65d3cc3..4e07371 100644 --- a/docs/table-of-contents.md +++ b/docs/table-of-contents.md @@ -20,8 +20,9 @@ * [Overview](#usage-overview) * [Options](#usage-options) -* [Basic Examples](#usage-basic-examples) +* [Supported Files](#usage-supported-files) * [File & Directory Handling](#usage-file-and-directory-handling) +* [Basic Examples](#usage-basic-examples) ## [Twee Notation](#twee-notation)