From 3e25f78854a236ce1c39351a7ce69c4ed3e47b1a Mon Sep 17 00:00:00 2001 From: StashAppDev Date: Sat, 23 Mar 2019 15:40:23 -0700 Subject: [PATCH] Update README.md [ci skip] --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 65af2d6fa..431bee4f9 100644 --- a/README.md +++ b/README.md @@ -15,10 +15,6 @@ Simply run the executable (double click the exe on windows or run `./stash-osx` *Note for Windows users:* Running the app might present a security prompt since the binary isn't signed yet. Just click more info and then the run anyway button. -## Slack - -I created a Slack channel to discuss the project. [Click here to join.](https://join.slack.com/stash-project/shared_invite/MTc2Nzg0NjAyNzg4LTE0OTM1ODU4MTgtNDcwODRiMGIwYQ) - #### FFMPEG If stash is unable to find or download FFMPEG then download it yourself from the link for your platform: @@ -29,6 +25,10 @@ If stash is unable to find or download FFMPEG then download it yourself from the The `ffmpeg(.exe)` and `ffprobe(.exe)` files should be placed in `~/.stash` on macOS / Linux or `C:\Users\YourUsername\.stash` on Windows. +## Slack + +I created a Slack channel to discuss the project. [Click here to join.](https://join.slack.com/stash-project/shared_invite/MTc2Nzg0NjAyNzg4LTE0OTM1ODU4MTgtNDcwODRiMGIwYQ) + # FAQ TODO @@ -38,6 +38,7 @@ TODO ## Install * [Revive](https://github.com/mgechev/revive) - Configurable linter `go get github.com/mgechev/revive` +* [Yarn](https://yarnpkg.com/en/docs/install) - Yarn package manager ## Environment @@ -63,7 +64,7 @@ TODO ## Building a release -1. cd into the UI directory and run `ng build --prod` to compile the frontend +1. cd into the `ui/v2` directory and run `yarn build` to compile the frontend 2. cd back to the root directory and run `make build` to build the executable for your current platform ## Cross compiling @@ -72,4 +73,4 @@ This project uses a modification of [this](https://github.com/bep/dockerfiles/tr where the app can be cross compiled. This process is kicked off by CI via the `scripts/cross-compile.sh` script. Run the following command to open a bash shell to the container to poke around: -`docker run --rm --mount type=bind,source="$(pwd)",target=/stash -w /stash -i -t stashappdev/compiler:latest /bin/bash` \ No newline at end of file +`docker run --rm --mount type=bind,source="$(pwd)",target=/stash -w /stash -i -t stashappdev/compiler:latest /bin/bash`