From ebd2492a8337b220565080b1c05d6e0a6225657b Mon Sep 17 00:00:00 2001 From: Zack Siri Date: Thu, 22 Feb 2024 13:52:59 +0700 Subject: [PATCH] Update readme --- .gitignore | 2 ++ README.md | 19 ++++++++++++++++++- 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 0cce111..5730a67 100644 --- a/.gitignore +++ b/.gitignore @@ -37,3 +37,5 @@ npm-debug.log .envrc +.DS_Store + diff --git a/README.md b/README.md index a813c1a..a16366b 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ Polar is an image server for LXD / Incus. It has some useful features like + Feed specific to incus / lxd, you can choose when creating credentials. + Users can create `spaces` to manage multiple credentials. +The build system for polar is called [icepak](https://github.com/upmaru/icepak). It's designed to run as a github action, you can see it in action [here](https://github.com/upmaru/opsmaru-images). ## Basic Architecture @@ -13,7 +14,23 @@ Polar is an image server for LXD / Incus. It has some useful features like ## Development -Clone the repository and start the server with +Make sure you have Elixir / OTP installed. If you have asdf in your environment simply run + +```shell +asdf install +``` + +### Install Dependencies + +Install dependencies using mix: + +```shell +mix deps.get +``` + +## Start Server + +You can start the server with the following command. It will be hosted on port 4000 ```shell iex -S mix phx.server