Skip to content

Commit

Permalink
write a slighty better README
Browse files Browse the repository at this point in the history
  • Loading branch information
TitanNano committed Nov 7, 2018
1 parent 8c4484a commit 7209ff4
Showing 1 changed file with 34 additions and 4 deletions.
38 changes: 34 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,36 @@
# SystemJS
# Workbox

SystemJS is intended to be a JavaScript based web runtime environment.
It will provide a UI framework, Window Manager, Console, Virtual Filesystem and more.
Workbox is a desktop environment (simulator?) in your web browser.
Currently it can't do a lot and is mostly very alpha.

I will add more details soon.
But it's build with web workers, so that's cool.

## Install

To locally install Workbox on your machine you have to clone the repo,

```
git clone [email protected]:TitanNanoDE/Workbox.git
```

install all dependencies,

```
npm i
```

and you might have to set up sub modules.
Depending on the current state of the project, there will be different sub modules.

```
git submodule init
```

## Build
To build the project, make sure you have `gulp-cli`, then run it inside the project dir.
```
gulp
```

## Run
To run Workbox it has to be served by a web server. You can use Nginx, Apache2 or anything else.

0 comments on commit 7209ff4

Please sign in to comment.