From c176cae2b3e836c633c0818815083288ce796240 Mon Sep 17 00:00:00 2001
From: Prozilla <business@prozilla.dev>
Date: Sat, 15 Jul 2023 14:17:03 +0200
Subject: [PATCH] Added documentation

---
 .env                                          |  1 +
 README.md                                     | 42 ++++++++++++++++++-
 docs/README.md                                | 14 +++++++
 docs/contributing/README.md                   | 13 ++++++
 .../react/README.md                           |  0
 5 files changed, 69 insertions(+), 1 deletion(-)
 create mode 100644 .env
 create mode 100644 docs/README.md
 create mode 100644 docs/contributing/README.md
 rename REACT_GETTING_STARTED.md => docs/react/README.md (100%)

diff --git a/.env b/.env
new file mode 100644
index 0000000..5f32319
--- /dev/null
+++ b/.env
@@ -0,0 +1 @@
+BROWSER=none
\ No newline at end of file
diff --git a/README.md b/README.md
index 16ba62f..6feef8a 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,41 @@
-# ProzillaOS
\ No newline at end of file
+# ProzillaOS
+
+ProzillaOS is a web operating system inspired by Ubuntu Linux and Windows made in React by Prozilla. It aims to function much like a real operating system, with the exception of running entirely on the web.
+
+> Please note that ProzillaOS is far from complete and many additional features will be added in the future.
+
+## Features
+
+ProzillaOS will eventually have all the following features:
+
+### Desktop
+
+A desktop with a cool wallpaper is something every OS with a UI should have. The desktop will be a place where you can place shortcuts for your folders, files and apps.
+
+### Fully functional taskbar
+
+The taskbar will include a search feature, pinned applications, the current date and time and other common taskbar functionality.
+
+### Applications
+
+ProzillaOS will have a modular windows system that makes building applications a breeze. Each application will open a resizable window when opened, with common buttons like minimize, toggle fullscreen and exit. Every app will have its own functionality. Some examples of applications are File Explorer, Media Viewer, Terminal, Code Editor, Browser.
+
+### Folders and files
+
+File Explorer will let you explore, add and delete your folders and files. All of ProzillaOS' storage will be stored in local browser storage as JSON.
+
+### Adjustable settings
+
+The settings app will have options like changing the wallpaper, etc.
+
+### Games
+
+Yes, you read that right. ProzillaOS will have playable games. Initially, the only games will be [Prozilla's minigames](https://prozilla.dev/minigames/), but this can easily be expanded to feature more games in the future.
+
+## Documentation
+
+See [docs](docs) for more information.
+
+## License
+
+This project is licensed under the MIT license, Copyright (c) 2023 Sieben De Beule. For more information see [LICENSE.md](LICENSE.md).
\ No newline at end of file
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..d303cc0
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,14 @@
+# Documentation
+
+## Table of contents
+
+- [Contributing](contributing)
+- [React](react)
+
+## Overview
+
+### Getting started
+
+1. Clone this repository.
+2. Run `npm install`.
+3. Run `npm start` and visit [localhost:3000](http://localhost:3000/).
\ No newline at end of file
diff --git a/docs/contributing/README.md b/docs/contributing/README.md
new file mode 100644
index 0000000..1387f14
--- /dev/null
+++ b/docs/contributing/README.md
@@ -0,0 +1,13 @@
+# Contributing
+
+1. Fork this repository.
+2. Make and test changes.
+3. Create a pull request.
+4. Pat yourself on the back.
+
+Alternatively, if you do not feel like you can contribute to this project in this way, you can contribute by reporting bugs, suggesting new features, etc. by [creating issues](/issues).
+
+## Contribution guidelines
+
+- Make sure the changes you make are in line with the style of the rest of the project.
+- Make sure whatever you add or change is valuable.
diff --git a/REACT_GETTING_STARTED.md b/docs/react/README.md
similarity index 100%
rename from REACT_GETTING_STARTED.md
rename to docs/react/README.md