add readme, license, docs index
This commit is contained in:
parent
d2eec67355
commit
7e7cfbd747
|
@ -0,0 +1,23 @@
|
|||
# The MIT License (MIT)
|
||||
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2021 Sean Sube
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
|
@ -0,0 +1,55 @@
|
|||
# Textual Engine
|
||||
|
||||
This is a text adventure engine.
|
||||
|
||||
See [the getting started docs](docs/getting-started.md) for more info.
|
||||
|
||||
## Features
|
||||
|
||||
- text
|
||||
- adventure
|
||||
- world:
|
||||
- persistent rooms
|
||||
- wandering monsters
|
||||
- engine:
|
||||
- event broadcast
|
||||
- entity scripts
|
||||
|
||||
## Contents
|
||||
|
||||
- [Textual Engine](#textual-engine)
|
||||
- [Features](#features)
|
||||
- [Contents](#contents)
|
||||
- [Building](#building)
|
||||
- [Running](#running)
|
||||
- [Docs](#docs)
|
||||
- [License](#license)
|
||||
|
||||
## Building
|
||||
|
||||
Some `make` targets are provided:
|
||||
|
||||
- `make build`: transpile Typescript sources
|
||||
- `make test`: build and run `mocha` tests
|
||||
- `make cover`: run `make test` with `nyc` code coverage
|
||||
|
||||
## Running
|
||||
|
||||
Some `make` targets are provided:
|
||||
|
||||
- `make run`: run with test world
|
||||
|
||||
## Docs
|
||||
|
||||
More detailed docs [are located in `./docs`](docs/).
|
||||
|
||||
Available documentation includes:
|
||||
|
||||
- [Engine Architecture](docs/architecture.md)
|
||||
- [Development Workflow](docs/development.md)
|
||||
- [Getting Started](docs/getting-started.md)
|
||||
- [Creating Worlds](docs/worlds.md)
|
||||
|
||||
## License
|
||||
|
||||
This project uses [the MIT license](LICENSE.md).
|
|
@ -0,0 +1,8 @@
|
|||
# Docs
|
||||
|
||||
Available documentation includes:
|
||||
|
||||
- [Engine Architecture](architecture.md)
|
||||
- [Development Workflow](development.md)
|
||||
- [Getting Started](getting-started.md)
|
||||
- [Creating Worlds](worlds.md)
|
Loading…
Reference in New Issue