Updated docs
This commit is contained in:
Prozilla
parent
30cb42ce4a
commit
3b04978552
7 changed files with 54 additions and 20 deletions
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
# Configurations
|
||||
|
||||
All configs can be found in the [src/config](../../src/config) directory.
|
||||
All configs can be found in the [config](../../src/config) directory.
|
||||
|
||||
## Settings
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,12 @@
|
|||
|
||||
# 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.
|
||||
Most code for features can be found in the [features](../../src/features) directory. This directory is a library that is mostly used by files in the [components](../../src/components) and [hooks](../../src/hooks) directory.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Applications](./applications/README.md)
|
||||
- [Virtual Drive](./virtual-drive//README.md)
|
||||
- [Windows](./windows/README.md)
|
||||
- [Taskbar](./taskbar/README.md)
|
||||
|
||||
|
|
|
|||
|
|
@ -9,6 +9,36 @@ Applications (sometimes shortened to apps) are processes that open a window when
|
|||
- [<img src="../../../public/media/applications/icons/terminal.svg" width=20 height=20 style="vertical-align: middle; background: none;"/> Terminal](terminal/README.md)
|
||||
- [<img src="../../../public/media/applications/icons/file-explorer.svg" width=20 height=20 style="vertical-align: middle; background: none;"/> File Explorer](file-explorer/README.md)
|
||||
- [<img src="../../../public/media/applications/icons/media-viewer.svg" width=20 height=20 style="vertical-align: middle; background: none;"/> Media Viewer](media-viewer/README.md)
|
||||
- [<img src="../../../public/media/applications/icons/text-editor.svg" width=20 height=20 style="vertical-align: middle; background: none;"/> Text Editor](text-editor/README.md)
|
||||
|
||||
## Common components
|
||||
|
||||
### Header menu
|
||||
|
||||
The header menu is a useful component that can be added to app windows for quick access to useful functions, like saving and opening files. The header menu can also be used to add shortcuts for functions.
|
||||
|
||||
## Template components
|
||||
|
||||
### Webview
|
||||
|
||||
The webview template can be used to turn a webpage into an application by simply setting a source property. For more information, see the [example](#turning-a-webpage-into-an-application) below.
|
||||
|
||||
#### Example
|
||||
|
||||
```js
|
||||
// src/features/applications/applications.js
|
||||
|
||||
import { WebView } from "../../components/applications/templates/WebView.jsx";
|
||||
|
||||
export default class ApplicationsManager {
|
||||
static APPLICATIONS = [
|
||||
// ...
|
||||
new Application("Web App", "web-app", WebView, { source: "https://prozilla.dev/" }),
|
||||
]
|
||||
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -37,21 +67,4 @@ export default class ApplicationsManager {
|
|||
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
### Turning a webpage into an application
|
||||
|
||||
```js
|
||||
// src/features/applications/applications.js
|
||||
|
||||
import { WebView } from "../../components/applications/templates/WebView.jsx";
|
||||
|
||||
export default class ApplicationsManager {
|
||||
static APPLICATIONS = [
|
||||
// ...
|
||||
new Application("Web App", "web-app", WebView, { source: "https://prozilla.dev/" }),
|
||||
]
|
||||
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
|
@ -6,7 +6,7 @@ A command line tool.
|
|||
|
||||
## Commands
|
||||
|
||||
See [src/features/applications/terminal/commands.js](../../../../src/features/applications/terminal/commands.js) for a list of commands. You can edit this file to add/remove/edit commands.
|
||||
See [features/applications/terminal/commands.js](../../../../src/features/applications/terminal/commands.js) for a list of commands. You can edit this file to add/remove/edit commands.
|
||||
|
||||
### Examples
|
||||
|
||||
|
|
|
|||
5
docs/features/applications/text-editor/README.md
Normal file
5
docs/features/applications/text-editor/README.md
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
[← Back](../README.md)
|
||||
|
||||
# <img src="../../../../public/media/applications/icons/text-editor.svg" width=30 height=30 style="vertical-align: middle; background: none;"/> Text Editor
|
||||
|
||||
An application for editing text documents.
|
||||
13
docs/features/taskbar/README.md
Normal file
13
docs/features/taskbar/README.md
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
[← Back](../README.md)
|
||||
|
||||
# Taskbar
|
||||
|
||||
The taskbar serves as a hub for access to various other functionalites, mainly applications. It's very similar to Window's taskbar.
|
||||
|
||||
The taskbar can be split up into 3 main segments:
|
||||
|
||||
- Menus - This includes the home menu, where you can find quick access and a list of applications and the search menu, where you can search for applications by name.
|
||||
|
||||
- Apps list - This is a list of pinned applications, similar to how Window's taskbar pinning works.
|
||||
|
||||
- Indicators - This is a group of indicators that are used to display information, like battery power, network connection and volume.
|
||||
|
|
@ -4,6 +4,8 @@
|
|||
|
||||
The virtual drive is a virtual file and directory system. The root directory is a virtual folder and the access point for all interactions with the virtual drive.
|
||||
|
||||
The initial files added to every instance of ProzillaOS, can be found and configured in [hooks/virtual-drive/VirtualRootContext.js](../../../src/hooks/virtual-drive/VirtualRootContext.js)
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Virtual File](./virtual-file/README.md)
|
||||
|
|
|
|||
Loading…
Reference in a new issue