Skip to content

Commit 7fe2f39

Browse files
Merge pull request #36 from Notplayingallday383/new-tb-docs
New tb docs
2 parents 0c0e9d2 + 862c4e5 commit 7fe2f39

2 files changed

Lines changed: 62 additions & 52 deletions

File tree

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
title: TerbiumOS
3+
description: TerbiumOS is the next generation of
4+
---
5+
6+
<center>
7+
<img src="https://raw.githubusercontent.com/TerbiumOS/web-v2/refs/heads/main/card.png" style="display: block; margin-left: auto; margin-right: auto; width: 300px;"></img>
8+
<h1 style="color: #32ae62;">Terbium v2</h1>
9+
</center>
10+
11+
## <span style="color: #32ae62;">Some of the technologies used</span>
12+
13+
- [React](https://react.dev)
14+
- [TailwindCSS](https://tailwindcss.com)
15+
- [FilerJS](https://github.com/filerjs/filer)
16+
- [Fflate](https://github.com/101arrowz/fflate/)
17+
- [BareMux](https://github.com/mercuryworkshop/bare-mux)
18+
19+
## <span style="color: #32ae62;">Features</span>
20+
21+
- All new UI
22+
- A Dynamic Shell
23+
- Better Window Manager
24+
- A desktop
25+
- App Store
26+
- A brand new terminal
27+
- Anura Compatability layer (Liquor)
28+
- And lots more!
29+
30+
## <span style="color: #32ae62;">Setup</span>
31+
32+
> <span style="font-family: url('https://fonts.googleapis.com/css2?family=Roboto&display=swap'); color: #ffd900;">⚠</span> <span style="color: #ffd900;">NOTE:</span> Terbium **WILL NOT** build on versions of Node older than version 20.
33+
34+
To get started its pretty easy you need either npm or pnpm which can be installed by running: `npm i -g pnpm` and then just need to the run following command
35+
36+
```bash
37+
pnpm i && pnpm start # Replace pnpm with npm if your not going to use pnpm
38+
```
39+
40+
and visit [http://localhost:3000](http://localhost:3000) you should be good to go!
41+
42+
If you are developing/modifying terbium you can just run `pnpm run dev`, **DO NOT** use the development server for Production use instead just run `pnpm start`. For any further backend configuration visit the `.env` file to configure the backend a bit.
43+
44+
> <span style="font-family: none; color: #ffd900;">⚠</span> <span style="color: #ffd900;">Warning</span><br />
45+
> If you are going to static host Terbium you will need to change the wisp server and you would need to follow those steps. Refer to this [document](https://github.com/TerbiumOS/web-v2/tree/main/docs/static-hosting.md) for more information
46+
47+
### <span style="color: #32ae62;">Documentation</span>
48+
49+
If you wish to develop or just learn more about terbiums components and stuff feel free to read out [Documentation](https://github.com/TerbiumOS/web-v2/tree/main/docs/README.md)
50+
51+
If your looking to see what Anura APIs and features are supported in terbium, refer to: [here](https://github.com/TerbiumOS/web-v2/tree/main/docs/anura-compat.md)
52+
53+
### <span style="color: #32ae62;">Contributors</span>
54+
55+
- [SNOOT](https://github.com/NovaAppsInc)
56+
- [XSTARS](https://github.com/Notplayingallday383)
57+
- [illusionTBA](https://github.com/illusionTBA)
58+
- [Rafflesia](https://github.com/ProgrammerIn-wonderland)
59+
- [Riftriot](https://github.com/Riftriot)
60+
- [ironswordX](https://github.com/ironswordX)
61+
62+
Licensed under the [**AGPL3 License**](https://www.gnu.org/licenses/agpl-3.0.en.html)

‎src/content/docs/services/terbiumux.mdx‎

Lines changed: 0 additions & 52 deletions
This file was deleted.

0 commit comments

Comments
 (0)