Rooba
/
stash
mirror of https://github.com/stashapp/stash.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md 

[ci skip]
This commit is contained in:
StashAppDev 2019-03-23 15:40:23 -07:00 committed by GitHub
parent 255ec4822a
commit 3e25f78854
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -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`
`docker run --rm --mount type=bind,source="$(pwd)",target=/stash -w /stash -i -t stashappdev/compiler:latest /bin/bash`