From 0b268f2cd167f553841a05a5252dbcd684f1794e Mon Sep 17 00:00:00 2001 From: Harshad Sharma Date: Thu, 23 May 2024 14:27:46 +0530 Subject: [PATCH] Update development instructions in readme --- README.md | 27 +++++++++++++++++++++++---- 1 file changed, 23 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f1379c3..e4bca61 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,30 @@ # Freedive -To start your Phoenix server: +Dive into FreeBSD + +Freedive aims to provide a mobile-first WebUI to manage FreeBSD hosts, +designed to welcome beginners, hobbyists and tinkerers +to the FreeBSD ecosystem with minimal fuss. + +### Develop + +Clone the repository: + +- `git clone https://brew.bsd.cafe/hiway/freedive.git` +- `cd freedive` + +Install dependencies: + +- `pkg install -U -y inotify-tools doas` + +Setup your own account to run commands as root without password: + +- `echo "permit nopass as root" >> /usr/local/etc/doas.conf` + +Start Freedive: * Run `mix setup` to install and setup dependencies - * Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server` + * Start Freedive with `mix phx.server` or inside IEx with `iex -S mix phx.server` Now you can visit [`localhost:4000`](http://localhost:4000) from your browser. @@ -14,8 +35,6 @@ Now you can visit [`localhost:4000`](http://localhost:4000) from your browser. do NOT create accounts for people you do not trust to have root access on this machine. -### Devel - Create release: - `mix release --overwrite`