From eabd25b5b31a9b381ba41e46cadb340258e9eb2b Mon Sep 17 00:00:00 2001
From: "Sebastian A. Brachi" <Brachi@users.noreply.github.com>
Date: Sun, 17 Nov 2024 22:33:09 -0600
Subject: [PATCH] Update README.md

---
 README.md | 41 +++++++++++++++++------------------------
 1 file changed, 17 insertions(+), 24 deletions(-)

diff --git a/README.md b/README.md
index 09d7b7b..9b35ca5 100644
--- a/README.md
+++ b/README.md
@@ -1,46 +1,39 @@
 # Albam
 
 ⚠️  
-Albam is currently in heavy development and may be unstable. 
-Additionally, documentation is completely lacking except some quick videos and chat histories in discord.  
-For now, only use it if you really enjoy tinkering or can't wait.
+Albam is currently in heavy development and may be unstable.  
+There's no documentation yet.  
+⚠️  
 <p align="left">
 <a href="https://github.com/Brachi/albam/actions"><img alt="Actions Status" src="https://github.com/Brachi/albam/workflows/Test/badge.svg"></a>
 <img alt="Code coverage" src="https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/Brachi/879e4f106f38b080ff10d3f46e3336e6/raw/covbadge.json">
 </p>
 
-This is the source of _Albam_, a [Blender](https://blender.org) [addon](https://docs.blender.org/manual/en/latest/editors/preferences/addons.html) for importing and exporting 3d models and other game engine formats.  
-Its main purpose is modding, but also education and appreciation of game art.  
+This is the source of _Albam_, a [Blender](https://blender.org) [addon](https://docs.blender.org/manual/en/latest/editors/preferences/addons.html) for importing and exporting 3d models and other game engine formats.   
 
-For user-facing documentation and modding tutorials, refer to the [User Docs]()  
+For user documentation and modding tutorials, refer to the ~User Docs~ (TODO)  
 For real time communication, join the [Chat](https://discord.gg/69sphky9UX)
 
-## Supported Engines
-
-* [MT Framework](https://en.wikipedia.org/wiki/MT_Framework)
-
+## Quickstart
 
-## Supported Apps
-...
+Creating a virtualenv, installing dependencies and running tests (headless Blender)  
 
-## Architecture
-...
+```
+python -m venv .venv
+source .venv/bin/activate
+pip install .[tests]
+pytest
+```
+Note: you need application data to run mosts useful tests.
 
-## Developing
-
-...
-
-## Running Tests
-
-...
+## Supported Engines
 
-## Data
+* [MT Framework](https://en.wikipedia.org/wiki/MT_Framework)
 
-...
 
 ## Similar Tools
 
-* [Noesis](https://richwhitehouse.com/index.php?content=inc_projects.php&showproject=91) (native support for RE5)
+* [Noesis](https://richwhitehouse.com/index.php?content=inc_projects.php&showproject=91)
 * [Mod3-MHW-Importer](https://github.com/AsteriskAmpersand/Mod3-MHW-Importer)
 * [RevilMax](https://github.com/PredatorCZ/RevilMax])
 * [umvc3-tools](https://github.com/tge-was-taken/umvc3-tools)