From 3c2397bd0ae00bad5cfdc8ff37fe8b2321249182 Mon Sep 17 00:00:00 2001 From: m455 Date: Sun, 29 Mar 2020 15:56:58 -0400 Subject: [PATCH] updated readme --- README.md | 47 +++++++++++++++++++++++++---------------------- 1 file changed, 25 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index c0bc8c5..99bce5b 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,25 @@ # Tildemush documentation -This document serves as a reference for [tildemush](https://github.com/vilmibm/tildemush), -[tilde.town](https://tilde.town)'s tildemush virtual community, lead -by [vilmibm](https://tilde.town/~vilmibm/). +tildemush is a text-based, programmatic virtual community on the command line. tildemush aims to +provide an environment for creativity, imagination, and art. Currently, tildemush hosted on +[tilde.town](https://tilde.town). -This document is for users who have an account on [tilde.town](https://tilde.town). +tildemush may look like a chat room, but it is completely programmable, and includes other elements +such as: + +* Locations that can be traversed by users +* User-scripted objects that users can interact with +* User inventory and apparel +* A scripting tab for creating objects +* and many more + +# Purpose and goals + +TODO for vilmibm # Table of contents -- [What is tildemush?](#what-is-tildemush) -- [Purpose and goals](#purpose-and-goals) +- [About this document](#about-this-document) - [Conventions used in this documentation](#conventions-used-in-this-documentation) - [Requirements](#requirements) - [Getting started](#getting-started) @@ -63,6 +73,10 @@ This document is for users who have an account on [tilde.town](https://tilde.tow - [To share your WITCH code](#to-share-your-witch-code) - [Frequently asked questions](#frequently-asked-questions) + + + + -# What is tildemush? +# About this document -tildemush is a text-based, programmatic virtual community on the command line. tildemush aims to -provide an environment for creativity, imagination, and art. Currently, tildemush hosted on -[tilde.town](https://tilde.town). +This document serves as a reference for [tildemush](https://github.com/vilmibm/tildemush), +[tilde.town](https://tilde.town)'s tildemush virtual community, lead +by [vilmibm](https://tilde.town/~vilmibm/). -tildemush may look like a chat room, but it is completely programmable, and includes other elements -such as: - -* Locations that can be traversed by users -* User-scripted objects that users can interact with -* User inventory and apparel -* A scripting tab for creating objects -* and many more - -# Purpose and goals - -TODO for vilmibm +This document is for users who have an account on [tilde.town](https://tilde.town). # Conventions used in this documentation