Skip to content

Commit fbe198c

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

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

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

26+
## Getting started
27+
28+
1. Clone the GitHub repository.
29+
30+
```
31+
git clone https://github.com/prozilla-os/ProzillaOS.git ProzillaOS
32+
cd ProzillaOS
33+
```
34+
35+
2. Install package manager and dependencies
36+
37+
```
38+
npm i pnpm -g
39+
pnpm i
40+
```
41+
42+
3. Run project
43+
44+
```
45+
pnpm start
46+
```
47+
48+
4. Test local dev server by visiting [localhost:3000](http://localhost:3000/)
49+
50+
> [!TIP]
51+
> 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`.
52+
2653
## Packages
2754

2855
### Libraries (public)

0 commit comments

Comments
 (0)