populated \'conventions used in this handbook\'

main
m455 2020-01-07 18:05:03 -05:00
parent 083d350758
commit 892a5c5a58
1 changed files with 28 additions and 4 deletions

View File

@ -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.
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
**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)
<!-- markdown-toc end -->
# 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