SunRed/myriad
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update install instructions

Browse source
This commit is contained in:
1computer1 2020-06-17 03:29:29 -04:00
parent f67bc33a30
commit 6d3c165e67
1 changed files with 5 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -2,10 +2,10 @@
Arbitrary code execution server using Docker. Arbitrary code execution server using Docker.
## Download ## Download Pre-Built Binary
Check the `Releases` tab for pre-built binaries. Check the `Releases` tab for pre-built binaries.
The languages folder and the example configuration are also included. The languages folder and an example configuration are also included.
## Installation from Source ## Installation from Source
@ -13,20 +13,17 @@ You can use either `stack` or `cabal`.
- `stack` should be >= 2.1.1, `cabal` should be >= 2.4.0.0. - `stack` should be >= 2.1.1, `cabal` should be >= 2.4.0.0.
- GHC 8.8.3 is required if not already installed by `stack` or if using `cabal`. - GHC 8.8.3 is required if not already installed by `stack` or if using `cabal`.
#### Install Binary
Make sure the place where `stack` or `cabal` places binaries is in your PATH. Make sure the place where `stack` or `cabal` places binaries is in your PATH.
- For `stack`, you can get it with `stack path --local-bin`. - For `stack`, you can get it with `stack path --local-bin`.
- For `cabal`, you should find it in `$HOME/.cabal/bin` (Linux) or `%APPDATA%\cabal\bin` (Windows). - For `cabal`, you should find it in `$HOME/.cabal/bin` (Linux) or `%APPDATA%\cabal\bin` (Windows).
Run `stack install` or `cabal new-install` inside the project folder. Run `stack install` or `cabal new-install` inside the project folder.
Make sure the configuration is filled out, see `config.example.yaml` for an example. Or, to build within the project, run `stack build` or `cabal new-build`.
Run `myriad --config /path/to/config.yaml --languages /path/to/languages/`.
#### Install in Place ## Configuration
Make sure the configuration is filled out, see `config.example.yaml` for an example. Make sure the configuration is filled out, see `config.example.yaml` for an example.
Run `stack run` or `cabal v2-run` inside the project folder. Run `myriad` (or `stack run` or `cabal new-run` if you built within the project) to start the server.
The config and languages folder will default to `./config.yaml` and `./languages`. The config and languages folder will default to `./config.yaml` and `./languages`.
You can configure this with `--config` and `--languages`. You can configure this with `--config` and `--languages`.