Update README
This commit is contained in:
parent
a9f153e379
commit
a7efee86e5
20
README.md
20
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
|
deno task run
|
||||||
```
|
```
|
||||||
|
|
||||||
To compile
|
To compile:
|
||||||
```
|
```
|
||||||
deno task build
|
deno task build_all
|
||||||
```
|
```
|
||||||
|
|
||||||
You may need to install `xsel` on Linux machines to use this.
|
|
Loading…
x
Reference in New Issue
Block a user