reorganized sections
parent
bb1140d4fb
commit
b9509bf7a9
38
README.md
38
README.md
|
@ -11,9 +11,9 @@ If you are looking for a testing or developing environment, see
|
||||||
|
|
||||||
- [What is tildemush?](#what-is-tildemush)
|
- [What is tildemush?](#what-is-tildemush)
|
||||||
- [Purpose and goals](#purpose-and-goals)
|
- [Purpose and goals](#purpose-and-goals)
|
||||||
- [Getting started](#getting-started)
|
|
||||||
- [Conventions used in this documentation](#conventions-used-in-this-documentation)
|
- [Conventions used in this documentation](#conventions-used-in-this-documentation)
|
||||||
- [Requirements](#requirements)
|
- [Requirements](#requirements)
|
||||||
|
- [Getting started](#getting-started)
|
||||||
- [Starting tildemush](#starting-tildemush)
|
- [Starting tildemush](#starting-tildemush)
|
||||||
- [To start tildemush](#to-start-tildemush)
|
- [To start tildemush](#to-start-tildemush)
|
||||||
- [Creating a new user account](#creating-a-new-user-account)
|
- [Creating a new user account](#creating-a-new-user-account)
|
||||||
|
@ -125,23 +125,7 @@ tildemush looks like a chat room with elements such as:
|
||||||
|
|
||||||
TODO for vilmibm
|
TODO for vilmibm
|
||||||
|
|
||||||
# Getting started
|
# Conventions used in this documentation
|
||||||
|
|
||||||
This section describes conventions, which will help you understand the formatting used in this
|
|
||||||
document, and the requirements for using tildemush.
|
|
||||||
|
|
||||||
This section consists of the following subsections:
|
|
||||||
|
|
||||||
- [Conventions used in this documentation](#conventions-used-in-this-documentation)
|
|
||||||
- [Requirements](#requirements)
|
|
||||||
- [Starting tildemush](#starting-tildemush)
|
|
||||||
- [Creating a new user account](#creating-a-new-user-account)
|
|
||||||
- [Logging in](#loggin-in)
|
|
||||||
- [Resetting your password](#resetting-your-password)
|
|
||||||
- [Configuring tildemush](#configuring-tildemush)
|
|
||||||
- [Exiting from the start menu](#exiting-from-the-start-menu)
|
|
||||||
|
|
||||||
## Conventions used in this documentation
|
|
||||||
|
|
||||||
* **Note** - Notes signify additional information
|
* **Note** - Notes signify additional information
|
||||||
* **Tip** - Tips signify an alternate procedure for completing a step
|
* **Tip** - Tips signify an alternate procedure for completing a step
|
||||||
|
@ -152,10 +136,24 @@ This section consists of the following subsections:
|
||||||
* Section - Heading 1s are referred to as "Sections"
|
* Section - Heading 1s are referred to as "Sections"
|
||||||
* subsections - Heading 2s, 3s, etc. are referred to as "subsections"
|
* subsections - Heading 2s, 3s, etc. are referred to as "subsections"
|
||||||
|
|
||||||
## Requirements
|
# Requirements
|
||||||
|
|
||||||
* A [tilde.town](https://tilde.town) account
|
* A [tilde.town](https://tilde.town) account
|
||||||
|
|
||||||
|
# Getting started
|
||||||
|
|
||||||
|
This section describes conventions, which will help you understand the formatting used in this
|
||||||
|
document, and the requirements for using tildemush.
|
||||||
|
|
||||||
|
This section consists of the following subsections:
|
||||||
|
|
||||||
|
- [Starting tildemush](#starting-tildemush)
|
||||||
|
- [Creating a new user account](#creating-a-new-user-account)
|
||||||
|
- [Logging in](#loggin-in)
|
||||||
|
- [Resetting your password](#resetting-your-password)
|
||||||
|
- [Configuring tildemush](#configuring-tildemush)
|
||||||
|
- [Exiting from the start menu](#exiting-from-the-start-menu)
|
||||||
|
|
||||||
## Starting tildemush
|
## Starting tildemush
|
||||||
|
|
||||||
Starting tildemush will run the software required to connect to the
|
Starting tildemush will run the software required to connect to the
|
||||||
|
@ -171,7 +169,7 @@ any time.
|
||||||
|
|
||||||
1. `ssh` into [tilde.town](https://tilde.town)
|
1. `ssh` into [tilde.town](https://tilde.town)
|
||||||
2. Run `tmclient`
|
2. Run `tmclient`
|
||||||
3. Press the `enter-key`
|
3. Press the `enter` key
|
||||||
|
|
||||||
## Creating a new user account
|
## Creating a new user account
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue