summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorArjun Satarkar <me@arjunsatarkar.net>2024-11-02 19:52:25 +0000
committerArjun Satarkar <me@arjunsatarkar.net>2024-11-02 19:53:59 +0000
commit58d32f23eb0ebc988c6e0fd4c6c651c7757021a2 (patch)
treefeb7f793efd22648fe909fa580c2427b30c0451e /README.md
parent475286136da68c0a9cc8bec95d042f7243553fb4 (diff)
downloadmediasync-58d32f23eb0ebc988c6e0fd4c6c651c7757021a2.tar
mediasync-58d32f23eb0ebc988c6e0fd4c6c651c7757021a2.tar.gz
mediasync-58d32f23eb0ebc988c6e0fd4c6c651c7757021a2.zip
Clean up directory structure, improve README
Also this should make GitHub ignore the vendored code for the purpose of detecting programming languages used in the repository. See https://github.com/github-linguist/linguist/blob/main/docs/overrides.md#vendored-code
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/README.md b/README.md
index 956548f..f34f654 100644
--- a/README.md
+++ b/README.md
@@ -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.