Dev

README.md

@@ -1 +1,47 @@
 # Engine
+
+This repository contains the full engine for NanoForge.
+It can be used by itself.
+
+The engine is made of multiple components:
+
+- [ecs](packages/ecs)
+- [input](packages/input)
+- [core](packages/core)
+- [common](packages/common)
+- [graphics-2d](packages/graphics-2d)
+- [asset-manager](packages/asset-manager)
+- [sound](packages/sound)
+- [music](packages/music)
+
+This is the full nanoforge engine including all the default libraries.
+
+In order to manage this project we use (pnpm)[https://pnpm.io/]
+
+## Installing dependencies
+
+To install dependencies run:
+
+```sh
+pnpm i
+```
+
+## Building
+
+To build the project run:
+
+```sh
+pnpm build
+```
+
+## Tests
+
+To run tests use:
+
+```sh
+pnpm test
+```
+
+## Setting up a test project
+
+In order to setup a test project see (this)[https://github.com/NanoForge-dev/Engine/docs/Introduction.md]

docs/Introduction.md

@@ -0,0 +1,14 @@
+# Introduction to using the Engine
+
+Whether you work on this engine as a devlopper or you wanna use this engine you gonna want to have a test project.
+This is a walkthrough on how to setup a basic project
+
+## As a devlopper on the engine
+
+As a devlopper you want to be able to use your changes in your project.
+Therefore it is recommended to use the provided template in the [example](https://github.com/NanoForge-dev/Engine/tree/main/example/template)
+
+## As a user
+
+As a user you can either use the template and change the dependencies location.
+Or you can create a project and add the nanoforge dependencies. Note that it is recommended to use bun as a package manager.