diff options
Diffstat (limited to 'README.MD')
| -rw-r--r-- | README.MD | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/README.MD b/README.MD new file mode 100644 index 0000000..839678d --- /dev/null +++ b/README.MD @@ -0,0 +1,20 @@ +# Monkey Type, but for desktop! +Basically title. + +## Useful Links +- [Original Monkey Type open source repository](https://github.com/Miodec/monkey-type) +- [Monkey Type Website](https://monkey-type.com/) + +## Development Usage +1. Clone or download repository. +2. `$ yarn` or `$ npm i` to install dependencies. +3. `$ npm run start` to start the application. + +## Installation +1. Go to [releases](https://github.com/8cy/monkey-type-desktop/releases) +2. Download + +Currently, only Windows builds are in the release section, however, you can build Linux or Mac using the `$ npm run dist` script along side your platforms flag; `--windows`, `--linux` or `--mac`. + +### License +MIT
\ No newline at end of file |