Skip to content

Commit d06c2a8

Browse files
committed
Clarify usage of official repo
1 parent a62a5f7 commit d06c2a8

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

src/v3/install/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ full_title: Installation
77

88
Installation is done in a few simple steps and only takes a couple of minutes.
99

10+
> **[warning] Do not run OS.js as a "sudo" or "admin" user. This can cause issues with file permissions as might leave you open to security vulnerabilities.**
11+
1012
## Requirements
1113

1214
The only dependency is `node 10` or later and `git` is recommended.
@@ -29,9 +31,9 @@ Or check out the [official v3 online demo](https://demo.os-js.org/v3/). *Please
2931

3032
Make sure to read the [deployment guide](../guide/deploy/README.md) if you plan on installing in a production environment.
3133

32-
> **[warning] Do not use "sudo" or an administrator user for the setup procedure.**
34+
> **[info] The official repository is intended for you to use as a boilerplate to create your own distributions of OS.js. You can safely remove any files beloning to git afterwards if you used git, as well as modify the structure and included files as you see fit.**
3335
34-
Clone the base repository (or download a compressed version of latest release):
36+
Clone the official boilerplate repository (or download a compressed version of latest release):
3537

3638
```bash
3739
git clone -b master --single-branch https://github.com/os-js/OS.js.git

src/v3/resource/overview/README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,9 @@ The server-side scripts runs on node 10+, but uses `require` instead of `import/
2525

2626
## Distribution
2727

28-
The [OS.js repository](https://github.com/os-js/OS.js) is the main codebase that builds and bundles all of the components together.
28+
The [OS.js repository](https://github.com/os-js/OS.js) contains a boilerplate you can use to build and bundle your own distributions.
2929

30-
This is the standard layout for an OS.js distribution source:
31-
32-
> You can change this as you see fit, because all of the actual OS.js codebase is provided separately with `npm` packages.
30+
It comes with the following structure, that you can modify as you see fit:
3331

3432
```text
3533
webpack.config.js Webpack building configuration

0 commit comments

Comments
 (0)