mirrors/webxoss-core
1
0
Fork 1
mirror of https://github.com/webxoss/webxoss-core.git synced 2024-11-20 06:49:53 +01:00
Code Issues Projects Releases Packages Wiki Activity

📝 update README.md

Browse source
This commit is contained in:
Deardrops 2017-08-29 11:17:03 -05:00 • committed by WEBXOSS
parent 02ff7741d9
commit fab7301152
1 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -4,13 +4,15 @@
1. Clone this project
```
git clone https://github.com/webxoss/webxoss-core.git --recurse-submodules
```
2. Init / Update submodule
```
git submodule update --init
cd webxoss-client
git submodule update --init
cd -
cd webxoss-core
git submodule update --init --recursive
```
3. Download copyrighted images
@ -35,7 +37,7 @@
## Run
WEBXOSS can be runned in 2 modes: node or browser.
WEBXOSS can be runned in 2 modes: **node** or **browser**.
### Node mode
@ -44,13 +46,15 @@ Use nodejs to create a WEBXOSS server over network.
```
# listen to 127.0.0.1:80
node test.js
```
Then open `127.0.0.1`. That's it.
```
# or specify a port
node test.js port=8080
```
Then open `localhost`. That's it.
### Browser mode
WEBXOSS server can be runned in a browser tab, typically for easier debugging.
@ -62,4 +66,4 @@ Then, open `127.0.0.1` (map to `webxoss-core` folder). The browser tab you just
Note:
* The "server" and "client" tabs use `postMessage` to simulate network communications. So you can only play with yourself in a browser.
* See this [test guide](https://github.com/webxoss/webxoss-core/wiki/howToTest) for more test tricks.
* See this [test guide](https://github.com/webxoss/webxoss-core/wiki/Test-guide) for more test tricks.