From 6f35c4a8e413de97aebe9b9eeefc53e0bfff7940 Mon Sep 17 00:00:00 2001 From: rasul Date: Tue, 7 Apr 2020 14:48:01 -0500 Subject: [PATCH] update readme with some instructions --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 77be9e5..0c32740 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,13 @@ MUD game, in rust, so that hopefully it goes fast and doesn't break things. Under heavy development. Much is currently unimplemented or not completely implemented yet. -API docs can be built with `cargo doc`. Not yet complete, though. Also they are -available online at +API docs are available at [https://rascul.gitlab.io/rude/rude/index.html](https://rascul.gitlab.io/rude/rude/index.html). -If you really want to, clone the repo and run it with cargo. +``` +git clone https://gitlab.com/rascul/rude +cd rude +sqlite3 rude.db < schema.sql +cp config.toml.default config.toml +cargo run +```