From 028416f1017494b072331f5e62ad3e4b88afdb8e Mon Sep 17 00:00:00 2001 From: Diana Thayer Date: Sun, 21 May 2017 22:08:33 -0700 Subject: [PATCH 1/2] add links to readme for the location of relevant files and dependencies --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f4bdae5..963725a 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,7 @@ pull request (see the next section for details) ### The database -The pronouns "database" is a tab-delimited file with fields and -example values as follows: +The pronouns "database" is a tab-delimited file located in [resources/pronouns.tab][pronoun-database] with fields and example values as follows: subject|object|possessive-determiner|possessive-pronoun|reflexive -------|------|---------------------|------------------|--------- @@ -30,10 +29,12 @@ tab characters in that file (a thing your editor might normally be configured not to do!) In Emacs, you can input real tabs by doing Ctrl+q +[pronoun-database]: https://github.com/witch-house/pronoun.is/blob/develop/resources/pronouns.tab + ### Running the app in a dev environment -You can launch the app on your own computer by running the following -command: +First, install [leiningen](https://leiningen.org/). Then you can launch the app +on your own computer by running the following command: ``` $ lein ring server From 7ce17063e5b39c4a6cbccca796a29810ff38be6f Mon Sep 17 00:00:00 2001 From: Diana Thayer Date: Sun, 21 May 2017 22:23:31 -0700 Subject: [PATCH 2/2] oh, it *was* documented :| --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 963725a..32eb9ad 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ That's pretty unwieldy! Fortunately you can also give it only the first pronoun or two: http://pronoun.is/she/her or http://pronoun.is/they Automatically filling in the rest from only one or two forms only -works for pronouns in the [database](resources/pronouns.tab). If the +works for pronouns in the [database][pronoun-database]. If the pronouns you or a friend uses aren't supported, please let us know and we'll add them. Alternatively you could add them yourself and submit a pull request (see the next section for details) @@ -29,7 +29,7 @@ tab characters in that file (a thing your editor might normally be configured not to do!) In Emacs, you can input real tabs by doing Ctrl+q -[pronoun-database]: https://github.com/witch-house/pronoun.is/blob/develop/resources/pronouns.tab +[pronoun-database]: resources/pronouns.tab ### Running the app in a dev environment