From 19c17588f739d9c69a5d684799b60fb313d6b9a2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Matheus=20Lu=C3=ADs?= <matheus.bernardi@lnls.br>
Date: Wed, 2 Oct 2024 13:22:47 -0300
Subject: [PATCH] 1st draft on README

---
 README.md | 62 ++++++++++++++++++++++++++++++++++++-------------------
 1 file changed, 41 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index 49f6646..af9d54e 100644
--- a/README.md
+++ b/README.md
@@ -3,24 +3,44 @@
 This is a simple launcher for the Annotat3D tool. It is meant to control user sessions
 and to provide a simple interface to submit new Annotat3D jobs through the slurm scheduler.
 
-## TODO
-
-- [x] Signin page
-- [x] LDAP Credentials authentication
-- [x] ssh on login
-- [x] User area with Annotat3D job status
-- [x] Submit new Annotat3D job
-- [x] Parse Annotat3D job url
-- [x] Redirection to Annotat3D url
-- [x] Job status monitoring
-- [x] Job deletion
-- [x] Complete job script from a template controlled by the app
-- [x] Clean/Delete logs button + action
-- [ ] Expire idle jobs
-- [x] Select components for partition and gpu on job form
-- [x] Persist job id in the user session
-- [x] Improve the design of the instances page
-- [ ] Better state management of the instances
-- [x] Dockerfile
-- [x] CI build
-- [ ] Deployment
+# Usage
+
+The use of the running instance of this tool is restricted to CNPEM internal network. 
+One can access the tool by visiting the following URL:
+
+[https://annotat3d.lnls.br](https://annotat3d.lnls.br)
+
+But you can also run this tool locally by building the docker image and running it, provided that 
+you have access to a similar infrastructure and properly configured the environment variables.
+You can run the docker image with the following command:
+
+```bash
+docker compose up --build
+```
+
+# Development
+
+This project was built using [Next.js](https://nextjs.org/).
+
+## Installation
+
+To install the project, you need to have Node.js installed. Then, you can run:
+
+```bash
+pnpm install
+```
+
+## Running the development server
+
+To run the development server, you can run:
+
+```bash
+pnpm dev
+```
+
+This will start the development server on [http://localhost:3000](http://localhost:3000).
+
+# License
+
+This project is licensed under the GNU General Public License v3.0. You can find the full 
+license text in the [LICENSE](LICENSE) file.