From 892a5c5a5810db7ec97a4adbc3153901969f2aef Mon Sep 17 00:00:00 2001 From: m455 Date: Tue, 7 Jan 2020 18:05:03 -0500 Subject: [PATCH] populated \'conventions used in this handbook\' --- tildemush-handbook.md | 32 ++++++++++++++++++++++++++++---- 1 file changed, 28 insertions(+), 4 deletions(-) diff --git a/tildemush-handbook.md b/tildemush-handbook.md index 303e593..c7594df 100644 --- a/tildemush-handbook.md +++ b/tildemush-handbook.md @@ -1,8 +1,9 @@ # tildemush handbook -This handbook will serve as a reference for the tildemush virtual -community. It is intended for new and experienced users. This handbook -will provide an introduction to tildemush, understanding the -interface, using tildemush, and the WITCH scripting language. + +This handbook will serve as a reference for [tilde.town](https://tilde.town)'s tildemush virtual community. It is +intended for new and experienced users. This handbook will provide an +introduction to tildemush, understanding the interface, using +tildemush, and the WITCH scripting language. **Table of Contents** @@ -17,11 +18,25 @@ interface, using tildemush, and the WITCH scripting language. - [Requirements](#requirements) - [Platforms](#platforms) - [Software](#software) + - [Starting tildemush](#starting-tildemush) +- [Understanding the interface](#understanding-the-interface) +- [Using tildemush](#using-tildemush) +- [Scripting with WITCH](#scripting-with-witch) +- [More information](#more-information) # Quick start +This section is for people who are comfortable with what they know +about tildemush, but need a few commands to get them started. + +1. `ssh` into [tilde.town](https://tilde.town) + +2. Run `tmclient` + +3. Use the `up-arrow`, `down-arrow`, and `enter-key` to login or register + # What is tildemush? ## Description @@ -32,6 +47,13 @@ interface, using tildemush, and the WITCH scripting language. ## Conventions used in this handbook +* Note - Notes signify additional information +* Tip- Tips signify an alternate procedure for completing a step +* Caution - Cautions signify that damage may occur +* Example - Examples provide a visual reference of how a procedure would be performed +* Inline code - Inline code signifies package names, filenames, commands, and keyboard keys +* Code block - Code blocks signify file contents, or an interface element + ## Requirements ### Platforms @@ -45,3 +67,5 @@ interface, using tildemush, and the WITCH scripting language. # Using tildemush # Scripting with WITCH + +# More information