From 1763c0e3c44d5aaca17e944246bef3d4d236c01d Mon Sep 17 00:00:00 2001 From: Owen Jacobson Date: Tue, 16 Jun 2020 00:13:17 -0400 Subject: Add a README and project metadata. --- Cargo.toml | 2 ++ README.md | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+) create mode 100644 README.md diff --git a/Cargo.toml b/Cargo.toml index 70ab851..1ec0475 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,8 +1,10 @@ [package] name = "things-to-check" version = "0.4.1-alpha.0" +repository = "https://github.com/ojacobson/things-to-check/" publish = false authors = ["Owen Jacobson "] +homepage = "https://things-to-check.herokuapp.com/" edition = "2018" [dependencies] diff --git a/README.md b/README.md new file mode 100644 index 0000000..909dc53 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# Things To Check + +A friend of mine used to run an IRC bot that could provide "helpful" +troubleshooting suggestions, based on places the folks in that chat had stubbed +their toes in the past. + +I thought this was such a good idea, I turned it into a web bot. + +## You Will Need + +Want to work on this code, or run it yourself? Install the following: + +* [An installed copy of the Rust toolchain](https://rustup.rs). + +Building, testing, &c follow Rust norms: use +[Cargo](https://doc.rust-lang.org/cargo/guide/working-on-an-existing-project.html) +to build, test, or run the code locally. + +## Configuration + +By default, this app will listen on `http://localhost:3000/`. You can change the +port number by exporting a `PORT` environment variable in the process where this +program runs. + +## Vocabulary + +The list of suggestions is given by the `src/things-to-check.yml` file, which +contains a YAML list of strings. Each string is a Markdown snippet to render in +the page as a suggestion. + +Stable links provide the user with an index into this list. When you insert new +items, insert them at the end. -- cgit v1.2.3