Skip to content

Commit 0008b6a

Browse files
committed
Update readme
1 parent bf007a9 commit 0008b6a

File tree

1 file changed

+32
-5
lines changed

1 file changed

+32
-5
lines changed

README.md

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -111,12 +111,39 @@ System Runtime checks at runtime if the signatures of invoked methods are compli
111111

112112
With System Runtime your components really behave the way you designed them.
113113

114-
## Documentation
114+
## Build
115115

116-
* [Quick Start](https://system-runtime.readme.io/docs/quick-start)
117-
* [Guide](https://system-runtime.readme.io/docs/installation)
118-
* [Examples](https://system-runtime.readme.io/docs/a-basic-hello-world)
119-
* [Build System Runtime](https://system-runtime.readme.io/docs/extend-runtime)
116+
#### Installation
117+
118+
Clone the repository:
119+
120+
```sh
121+
# Clone the repository
122+
$ git clone https://github.com/design-first/system-runtime.git
123+
# Go to the repository
124+
$ cd system-designer
125+
```
126+
127+
Once you have cloned the repository:
128+
129+
```sh
130+
# install dependencies
131+
$ npm install
132+
```
133+
134+
#### Tasks
135+
136+
```sh
137+
# run tests
138+
$ npm run test
139+
# clean
140+
$ npm run clean
141+
# build System Runtime (on /dist/)
142+
# it will generate System Runtime core system (from /src/system/)
143+
# and package System Runtime client library
144+
# it will also run jshint and server/client tests
145+
$ npm run build
146+
```
120147

121148
## Community
122149

0 commit comments

Comments
 (0)