Skip to content

Commit

Permalink
meta: Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
sleepy-monax committed Nov 29, 2024
1 parent cec9ad8 commit 01ecdb6
Show file tree
Hide file tree
Showing 11 changed files with 56 additions and 42 deletions.
Binary file removed doc/assets/vaev.png
Binary file not shown.
Binary file removed doc/assets/vaev.webp
Binary file not shown.
30 changes: 19 additions & 11 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,19 @@
![skiftOS Screenshot](doc/assets/bento.png)

## About

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/3ad24f7f90be4c969de7444377906c1c)](https://app.codacy.com/gh/skift-org/skift/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) -
<br/>
<br/>

<p align="center">
<img src="doc/logo-light.svg#gh-light-mode-only" width="192" />
<img src="doc/logo-dark.svg#gh-dark-mode-only" width="192" />
</p>
<br/>
<p align="center">
<a href="https://skiftos.org/">Website</a> -
<a href="https://discord.com/invite/gamGsfg">Discord</a> -
<a href="https://docs.skiftos.org">Documentation</a>
</p>

<br/>
<br/>

> **⚠ Warning**<br> skiftOS is currently in the early stages of development and is not yet ready for daily use. Please do not use it in production environments. Here be dragons! 🐉
Expand All @@ -14,12 +22,12 @@

## Key Features

- **Karm**: A modern C++ core library providing foundational building blocks.
- **KarmUI**: A reactive UI framework for building elegant user interfaces.
- **Hideo**: A beautiful desktop environment prioritizing intuitive design.
- **Hjert**: A capability-based "pragmatic" microkernel.
- **CuteKit**: A versatile build system and package manager designed for cross-compilation and complex project management.
- **Vaev**: A browser engine built for speed, accuracy, and simplicity.
- [**Karm**](src/libs): A modern C++ core library providing foundational building blocks.
- [**KarmUI**](src/libs/karm-ui/): A reactive UI framework for building elegant user interfaces.
- [**Hideo**](src/apps): A beautiful desktop environment prioritizing intuitive design.
- [**Hjert**](src/kernel): A capability-based "pragmatic" microkernel.
- [**CuteKit**](https://github.com/cute-engineering/cutekit): A versatile build system and package manager designed for cross-compilation and complex project management.
- [**Vaev**](src/web): A browser engine built for speed, accuracy, and simplicity.

## Core Philosophy

Expand Down
Binary file added src/apps/doc/assets/capture.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions src/apps/doc/assets/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 25 additions & 0 deletions src/apps/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<br/>
<br/>
<p align="center">
<img src="doc/assets/logo.svg" width="200"s>
</p>
<p align="center">
A modern desktop environment for Skift & Linux
</p>
<br/>
<br/>

![](doc/assets/capture.jpg)

<br/>
<br/>

## License

<a href="https://www.gnu.org/licenses/lgpl-3.0.en.html">
<img align="right" height="72" alt="LGPL3 License" src="https://branding.cute.engineering/licenses/lgpl.svg" />
</a>

The hideo desktop environment is licensed under the **GNU Lesser General Public License v3.0 or later**.

The full text of the license can be accessed via [this link](https://www.gnu.org/licenses/lgpl-3.0-standalone.html) and is also included in the [license.txt](license.txt) file of this software package.
6 changes: 0 additions & 6 deletions src/clis/byg/main.cpp

This file was deleted.

9 changes: 0 additions & 9 deletions src/clis/byg/manifest.json

This file was deleted.

6 changes: 0 additions & 6 deletions src/clis/cc/main.cpp

This file was deleted.

10 changes: 0 additions & 10 deletions src/clis/cc/manifest.json

This file was deleted.

Binary file modified src/web/doc/assets/vaev.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 01ecdb6

Please sign in to comment.