Write first README

This commit is contained in:
maddiebaka 2023-10-22 14:10:12 -04:00
parent 66fc396504
commit 1e80e2cfe4
1 changed files with 5 additions and 20 deletions

View File

@ -1,24 +1,9 @@
# README
This README would normally document whatever steps are necessary to get the
application up and running.
TokiTranslate is a community-focused, collaborative website for translating the
[Toki Pona](https://en.wikipedia.org/wiki/Toki_Pona) dictionary into new languages.
Things you may want to cover:
Designed from the beginning for community ownership of all translations we produce. Export
of entire translated dictionaries available for download in JSON.
* Ruby version
* System dependencies
* Configuration
* Database creation
* Database initialization
* How to run the test suite
* Services (job queues, cache servers, search engines, etc.)
* Deployment instructions
* ...
Under active development and not yet live.