From 888bac4947dfbdf9de8791d873401ce761670905 Mon Sep 17 00:00:00 2001
From: Victor Martinez <49537445+JasterV@users.noreply.github.com>
Date: Sun, 31 Mar 2024 17:07:30 +0200
Subject: [PATCH] update README

---
 README.md | 34 +++++++++++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e075513..fbcc87c 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,39 @@
 
 Create private sessions to control vibration-based devices remotely
 
-### Notes on the project name
+## Run locally
+
+Make sure you have `elixir` and `erlang` installed on your local machine.
+
+A personal recommendation is to install them using [`asdf`](https://github.com/asdf-vm/asdf)
+or my new favourite [`mise`](https://github.com/jdx/mise).
+
+Then, make sure you have phoenix [installed](https://hexdocs.pm/phoenix/installation.html).
+You can ignore the Ecto setup part, this project doesn't use Ecto for now.
+
+After making sure you have elixir installed and the `mix` tool running, go to the root of the project and run:
+
+1. Install javascript dependencies
+
+```bash
+cd assets && npm install && cd ..
+```
+
+2. Install elixir dependencies & build assets
+
+```bash
+mix setup
+```
+
+3. Run the project inside and start iex
+
+```bash
+iex -S mix phx.server
+```
+
+Now you can go to `localhost:4000` and start playing around :)
+
+## Notes on the project name
 
 Despite the similarity on the name, this project is not endorsed by [Intiface](https://github.com/intiface) and [Intiface](https://github.com/intiface) is their own registered trademark.