Merge pull request #16 from PixiEditor/update-readme

Adjusted README.md

Author: CPKreu

README.md

@@ -1,54 +1,39 @@
-# Starlight Starter Kit: Basics
+# PixiEditor Docs
 
-[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
+The Documentation for [PixiEditor](https://github.com/PixiEditor/PixiEditor)
 
-```
-npm create astro@latest -- --template starlight
-```
+Built with [Starlight](https://starlight.astro.build/getting-started/) and [Tailwind](https://tailwindcss.com/docs/)
 
-[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
-[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
-[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
-[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
+## File Structure
 
-> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
+All docs are located at `src/assets/docs`
 
-## 🚀 Project Structure
+Images can be added to `src/assets/`
 
-Inside of your Astro + Starlight project, you'll see the following folders and files:
+### Usage
 
-```
-.
-├── public/
-├── src/
-│   ├── assets/
-│   ├── content/
-│   │   ├── docs/
-│   └── content.config.ts
-├── astro.config.mjs
-├── package.json
-└── tsconfig.json
-```
+`src/contents/usage` contains documentation about the usage of PixiEditor, and is oriented towards the users of PixiEditor.
 
-Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
+### Contribution
 
-Images can be added to `src/assets/` and embedded in Markdown with a relative link.
+`src/contents/contribution` contains documentation on how to work on the source code of [PixiEditor](https://github.com/PixiEditor/PixiEditor)
 
-Static assets, like favicons, can be placed in the `public/` directory.
+It is oriented towards developers working on PixiEditor
 
-## 🧞 Commands
+## Developing & Running
 
-All commands are run from the root of the project, from a terminal:
 
-| Command                   | Action                                           |
-| :------------------------ | :----------------------------------------------- |
-| `npm install`             | Installs dependencies                            |
-| `npm run dev`             | Starts local dev server at `localhost:4321`      |
-| `npm run build`           | Build your production site to `./dist/`          |
-| `npm run preview`         | Preview your build locally, before deploying     |
-| `npm run astro ...`       | Run CLI commands like `astro add`, `astro check` |
-| `npm run astro -- --help` | Get help using the Astro CLI                     |
+### VS Code / VSCodium
 
-## 👀 Want to learn more?
+Go to the Run tab and run the `Development Server` launch configuration
 
-Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
+#### Recommended Extensions
+* [Astro](https://marketplace.visualstudio.com/items?itemName=astro-build.astro-vscode)
+* [Tailwind CSS](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss)
+* [MDX](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx)
+
+### CLI
+
+```bash
+yarn dev
+```