Added docs

Chelsea486MHz · Dec 25, 2023 · d313634 · d313634
1 parent ba19720
commit d313634
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 1 deletion.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1 @@
+Be nice.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1 @@
+Contributions are welcome.
diff --git a/README.md b/README.md
@@ -1,2 +1,39 @@
+![](./docs/logo.png)
+
 # stargazer
-Framework for hardware-agnostic, massively distributed N-body processing
+
+**Status (master branch)**
+
+![](https://img.shields.io/badge/maintained-yes-green) ![](https://img.shields.io/badge/license-MIT-blue) 
+
+---
+
+**What is Stargazer Framework ?**
+
+Stargazer Framework is an open source system for building an entire hardware-agnostic, massively distributed N-body processing super-cluster from the comfort of your chair.
+
+**Architecture**
+
+Stargazer Framework is built around a hardware-agnostic compute server that can be deployed on just about anything. Live telemetry from manager nodes allow for near-instantaneous workload adjustments, allowing each machine to contribute their best to the cluster.
+
+All computations can be easily modified, allowing for new mathematical models to be easily deployed and shared.
+
+**Installation guide**
+
+See [installation.md](./docs/installation.md)
+
+**Configuration guide**
+
+See [configuration.md](./docs/configuration.md)
+
+**Contributions**
+
+See [CONTRIBUTING.md](./contributing.md)
+
+**Code of conduct**
+
+See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)
+
+**Active contributors**
+
+Chelsea Murgia ([email](mailto:mail@chelsea486mhz.fr))
diff --git a/docs/logo.png b/docs/logo.png