-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
34 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |