diff --git a/README.md b/README.md index 86d687b..d235a9e 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,21 @@ -# fantasy-console +# Faux -To run, +Go to the [Releases](https://git.playbox.link/dylan/fantasy-console/releases) page to find downloadable executables. + +NOTE: If you are running Faux on Linux, you will need to have `xsel` installed. + +## Developing + +Faux is written in TypeScript to be run or compiled by [Deno](https://deno.com/runtime). + +If you want to build from source, you should have Deno installed, clone this repo, and then... + +To run: ``` deno task run ``` -To compile +To compile: ``` -deno task build -``` - -You may need to install `xsel` on Linux machines to use this. \ No newline at end of file +deno task build_all +``` \ No newline at end of file