Updated documentation + added config

This commit is contained in:
Prozilla 2023-07-22 17:42:56 +02:00
parent 6e454ae3e8
commit 56760e55c9
No known key found for this signature in database
GPG key ID: 5858DFE71CAF31EE
7 changed files with 80 additions and 17 deletions

View file

@ -2,6 +2,8 @@
## Table of contents
- [Features](features)
- [Configurations](configurations)
- [Contributing](contributing)
- [React](react)
@ -41,4 +43,8 @@
- [docs](.) directory
You are here. This directory contains all documentation for this project.
You are here. This directory contains all documentation for this project.
- [build](../build) directory
Contains the static build files after [building](#building--deploying) the application.

View file

@ -0,0 +1,7 @@
# Configurations
All configs can be found in the [src/config](../../src/config) directory.
## Settings
- `wallpaper` - The url of the image used as the wallpaper.

47
docs/features/README.md Normal file
View file

@ -0,0 +1,47 @@
# Features
Most code for features can be found in the [src/features](../../src/features) directory. This directory is a library that is mostly used by files in the [src/components](../../src/components) and [src/hooks](../../src/hooks) directory.
## Applications
There are several applications.
### Terminal
A command line tool.
### Code Editor
Coming soon.
### File Explorer
Coming soon.
### Media Viewer
Coming soon.
## Desktop
Coming soon.
## Math
The math folder contains util classes related to maths.
## Storage
Coming soon.
## Taskbar
Shows pinned applications, a search button, multiple control buttons and the time and date.
## Virtual Drive
The virtual drive is a drive that stores virtual files and folders.
## Windows
Each application opens in a window that can be dragged around and maximized/minimized.

View file

@ -4,7 +4,6 @@
left: 0;
width: 100%;
height: 100%;
background-image: url("/public/media/wallpapers/wallpaper1.png");
background-size: cover;
text-align: center;
}

View file

@ -3,12 +3,13 @@ import { Taskbar } from "./components/TaskBar.js";
import { WindowsManagerProvider } from "./hooks/WindowsManagerContext.js";
import { WindowsView } from "./components/WindowsView.js";
import { VirtualRootProvider } from "./hooks/VirtualRootContext.js";
import { SETTINGS } from "./config/settings.js";
function App() {
return (
<VirtualRootProvider>
<WindowsManagerProvider>
<div className="App">
<div className="App" style={{ backgroundImage: `url(${SETTINGS.wallpaper})` }}>
<Taskbar/>
<WindowsView/>
</div>

3
src/config/settings.js Normal file
View file

@ -0,0 +1,3 @@
export const SETTINGS = {
wallpaper: "/media/wallpapers/wallpaper1.png"
};

View file

@ -81,6 +81,16 @@
font-weight: 800;
}
html, body, #root {
width: 100%;
height: 100%;
}
html {
overflow: hidden;
background-color: var(--background-color-c);
}
body {
margin: 0;
font-family: var(--body-font-family);
@ -88,20 +98,6 @@ body {
-moz-osx-font-smoothing: grayscale;
}
code {
font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New',
monospace;
}
html {
overflow: hidden;
}
html, body, #root {
width: 100%;
height: 100%;
}
* {
color: var(--foreground-color-a);
box-sizing: border-box;
@ -110,4 +106,8 @@ html, body, #root {
p, a, button, input, h1, h2, h3, h4, h5, h6 {
font-family: var(--body-font-family);
letter-spacing: 0.01rem;
}
code {
font-family: var(--mono-font-family);
}