diff options
-rw-r--r-- | README.md | 24 |
1 files changed, 3 insertions, 21 deletions
diff --git a/README.md b/README.md index 7db80e4..e4e005e 100644 --- a/README.md +++ b/README.md | |||
@@ -1,24 +1,6 @@ | |||
1 | # README | 1 | # pokeviewer |
2 | 2 | ||
3 | This README would normally document whatever steps are necessary to get the | 3 | This is a Rails app that is able to display Pokemon extracted ([gen3uploader](https://code.fourisland.com/gen3uploader/about/)) from a third generation handheld Pokemon game. |
4 | application up and running. | ||
5 | 4 | ||
6 | Things you may want to cover: | 5 | The canonical instance of this is [https://www.fourisland.com/poke3/](https://www.fourisland.com/poke3/). |
7 | 6 | ||
8 | * Ruby version | ||
9 | |||
10 | * System dependencies | ||
11 | |||
12 | * Configuration | ||
13 | |||
14 | * Database creation | ||
15 | |||
16 | * Database initialization | ||
17 | |||
18 | * How to run the test suite | ||
19 | |||
20 | * Services (job queues, cache servers, search engines, etc.) | ||
21 | |||
22 | * Deployment instructions | ||
23 | |||
24 | * ... | ||