You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-67Lines changed: 5 additions & 67 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,74 +48,12 @@ Then you can use monoco on your script:
48
48
monoco.version();
49
49
```
50
50
51
-
## Examples
51
+
## Documentations
52
52
53
-
You will find examples on [monoco website](https://monoco.readme.io/docs/a-basic-hello-world).
54
-
55
-
## Documentation
56
-
57
-
You will find documentations on [monoco website](https://monoco.readme.io/docs).
58
-
59
-
## Build monoco
60
-
61
-
Once you have cloned the repository:
62
-
63
-
```sh
64
-
# for server tests (maybe you have this installed already)
65
-
$ npm install -g jasmine-node
66
-
# for client build (maybe you have this installed already)
67
-
$ npm install -g browserify
68
-
# needed by grunt (maybe you have this installed already)
69
-
$ npm install -g grunt-cli
70
-
# install dev dependencies
71
-
$ npm install
72
-
# build monoco
73
-
$ grunt build
74
-
```
75
-
76
-
#### Grunt
77
-
78
-
To extend monoco core system or to package your own system with monoco, you will need to use grunt commands. Here are the different tasks you can use to automate tasks:
79
-
80
-
```sh
81
-
# run server tests (from /test/)
82
-
$ grunt test
83
-
# generate the documentation (on /doc/)
84
-
$ grunt doc
85
-
# clean the build directory
86
-
$ grunt clean
87
-
# build monoco on 'debug' mode (on /build/)
88
-
# it will generate monoco core system (from /src/system/)
89
-
# and package monoco client library
90
-
# it will also run jshint and server tests
91
-
$ grunt debug
92
-
# build monoco (on /build/)
93
-
# it will generate monoco core system (from /src/system/)
94
-
# and package monoco client library
95
-
# it will also run jshint and server and client tests
96
-
$ grunt build
97
-
```
98
-
99
-
#### monoco core system
100
-
101
-
monoco has got a **customizable core system**. You can update all its components, models or behaviors to follow your needs.
102
-
103
-
monoco core system is located on the [/src/system](./src/system) directory:
104
-
*``` behaviors ```: contains all the behaviors of the core components of monoco,
105
-
*``` components ```: contains all the core components of monoco,
106
-
*``` schemas ```: contains all the schemas of the core components of monoco and
107
-
*``` types ```: contains all the types of the core components of monoco.
108
-
109
-
When you have finished to update monoco core system, just build monoco.
110
-
111
-
#### monoco addons
112
-
113
-
You can extend monoco core system **by composing other systems** with it. In that case, other systems are called **addons**.
114
-
115
-
monoco addons are located on the [/addons](./addons/) directory.
116
-
You will find there all the systems that you can import.
117
-
118
-
To compose a system with monoco core system, just copy and paste a system into the [/src/addons](./src/addons/) directory and build monoco.
0 commit comments