diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 17 insertions, 1 deletions
@@ -4,6 +4,22 @@ Watch a video in sync with other people remotely. The host can pause, seek withi The server is written in Elixir, and the frontend in JavaScript using [video.js](https://videojs.com/). +## Usage + +Development: + +```bash +(set -a && source .env && mix run) +``` + +Production: + +```bash +yes | MIX_ENV=prod mix release +(set -a && source .env && _build/prod/rel/mediasync/bin/mediasync start) +# ...or some fancier way to start the app or manage env vars, if you like +``` + ## Copyright and License Notice Copyright (C) 2024-present Arjun Satarkar @@ -23,4 +39,4 @@ along with this program. If not, see <https://www.gnu.org/licenses/>. ### Note on Vendored Libraries -Present in the source tree of this project are certain other open source projects used as dependencies, eg. [video.js](https://videojs.com/) and [Font Awesome](https://fontawesome.com/). The licenses applicable to those projects are present in the directories in which they are contained. +Present in the directory `priv/static/vendored` are certain other open source projects used as dependencies, eg. [video.js](https://videojs.com/) and [Font Awesome](https://fontawesome.com/). The license applicable to each such project is present in the directory of that project. |