Skip to content

Commit 8132ef2

Browse files
committed
Added installation process to README
1 parent ecce825 commit 8132ef2

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,35 @@ ProzillaOS is a web-based operating system inspired by Ubuntu Linux and Windows.
2323
<br />
2424
</div>
2525

26+
## Getting started
27+
28+
Make sure you have [NodeJS](https://nodejs.org/en) (version v18.12 or higher) installed on your device.
29+
30+
1. Clone the GitHub repository.
31+
32+
```
33+
git clone https://github.com/prozilla-os/ProzillaOS.git ProzillaOS
34+
cd ProzillaOS
35+
```
36+
37+
2. Install package manager and dependencies
38+
39+
```
40+
npm i pnpm -g
41+
pnpm i
42+
```
43+
44+
3. Run project
45+
46+
```
47+
pnpm start
48+
```
49+
50+
4. Test local dev server by visiting [localhost:3000](http://localhost:3000/)
51+
52+
> [!TIP]
53+
> If you encounter an error saying `module not found`, that probably means you haven't built the packages yet. In most cases, you can fix this by typing `pnpm run packages:build`.
54+
2655
## Packages
2756

2857
### Libraries (public)
@@ -140,4 +169,4 @@ ProzillaOS is [MIT licensed](./LICENSE).
140169
[browser]: ./packages/apps/browser/
141170
[calculator]: ./packages/apps/calculator/
142171
[logic-sim]: ./packages/apps/logic-sim/
143-
[license]: ./LICENSE
172+
[license]: ./LICENSE

0 commit comments

Comments
 (0)