Jean-Yves Didier

fixing descriptions for install process

......@@ -29,3 +29,33 @@ the last one being executed in the local sources repository:
In order to build or rebuild the engine, you will have to call webpack. If
you prefer, it is included as a command in file *package.json*.
To generate documentation and prepare components, type `npm run setup`
Creating an application
-----------------------
The first thing is to create a directory, then start a repository using npm and
install arcs.
`mkdir myapp`
`npm init -y`
`npm install arcsjs`
To install components on a per need basis, you should a component repository
that is setup. You can do it locally by running:
`npx arcsrepos -d path_to_components`
Then you set a repository environment variable or specify it on command line
each time you install a component:
`export ARCS_REPOSITORY=/path/to/components/repository.json`
`npx arcsm -i library_or_component_name`
Or you can do it like this:
`npx arcsm -i library_or_component_name -r /path/to/components/repository.json`
......
......@@ -64,22 +64,22 @@ ARCS.__lib__`
"ARUCO",
"marker",
"detector"
],
]
}
},
"dependencies": [ "js-aruco"],
"recipes": [
{
"from": 'node_modules/js-aruco/src/aruco.js',
"to": '../deps/aruco/index.js',
"from": "node_modules/js-aruco/src/aruco.js",
"to": "deps/aruco/index.js",
"replace" : {
"var CV = require('./cv');": "import CV from '../cv/index.js';",
"module.exports = AR;": "export default AR;"
}
},
{
"from": 'node_modules/js-aruco/src/cv.js',
to: '../deps/cv/index.js',
"from": "node_modules/js-aruco/src/cv.js",
"to": "../deps/cv/index.js",
"replace" : {
"module.exports = CV;": "export default CV;"
}
......
......@@ -335,7 +335,7 @@ ARCS.__lib__`
"recipes": [
{
"from": "node_modules/three/build/three.module.js",
"to": "../deps/three.js/index.js"
"to": "deps/three.js/index.js"
}
]
}
......
......@@ -161,7 +161,7 @@ ARCS.__lib__`
"geolocation",
"location"
]
},
}
}
}
`;
......
......@@ -132,12 +132,12 @@ ARCS.__lib__`
"transformation"
]
}
}
},
"dependencies": ["three"],
"recipes": [
{
"from": "node_modules/three/build/three.module.js",
"to": "../deps/three.js/index.js"
"to": "deps/three.js/index.js"
}
]
}
......
......@@ -119,24 +119,24 @@ ARCS.__lib__`
"keywords": ["OBJ", "3D", "model"]
}
},
"dependencies": [ "three.js"],
"dependencies": [ "three"],
"recipes": [
{
"from": "node_modules/three/build/three.module.js",
"to": "../deps/three.js/index.js"
"to": "deps/three.js/index.js"
},
{
"from": "node_modules/three/examples/jsm/loaders/OBJLoader.js",
"to": "../deps/objloader/index.js",
"to": "deps/objloader/index.js",
"replace" : {
'../../../build/three.module.js': '../three.js/index.js'
"../../../build/three.module.js": "../three.js/index.js"
}
},
{
"from": "node_modules/three/examples/jsm/loaders/MTLLoader.js",
"to": "../deps/mtlloader/index.js",
"to": "deps/mtlloader/index.js",
"replace" : {
'../../../build/three.module.js': '../three.js/index.js'
"../../../build/three.module.js": "../three.js/index.js"
}
}
]
......
......@@ -61,11 +61,11 @@ ARCS.__lib__`
"transformation"
]
}
}
},
"dependencies": ["three"],
"recipes": {
"from": "node_modules/three/build/three.module.js",
"to": "../deps/three.js/index.js"
"from": "node_modules/three/three.module.js",
"to": "deps/three.js/index.js"
}
}
`;
......
......@@ -84,7 +84,7 @@ ARCS.__lib__`
},
"dependencies": [ "jsqr"],
"recipes": [
{ "from": "node_modules/jsqr/dist/jsQR.js", "to": "../deps/jsqr/jsQR.js"}
{ "from": "node_modules/jsqr/dist/jsQR.js", "to": "deps/jsqr/jsQR.js"}
]
}`;
*/
\ No newline at end of file
......
......@@ -194,7 +194,7 @@ ARCS.__lib__`
"dependencies": [ "three" ],
"recipes": {
"from": "node_modules/three/build/three.module.js",
"to": "../deps/three.js/index.js"
"to": "deps/three.js/index.js"
}
}
`;
......
......@@ -170,7 +170,7 @@ ARCS.__lib__`
"dependencies": [ "three" ],
"recipes": {
"from": "node_modules/three/build/three.module.js",
"to": "../deps/three.js/index.js"
"to": "deps/three.js/index.js"
}
}
`;
......
......@@ -216,21 +216,19 @@ ARCS.__lib__`
}
},
"dependencies": ["three"],
"recipes": {
"recipes": [
{
"from": "node_modules/three/build/three.module.js",
"to": "../deps/three.js/index.js"
},
{
"from": "node_modules/three/examples/jsm/webxr/ARButton.js",
"to": "../deps/three.js/ARButton.js",
"replace": {
"../../../build/three.module.js": "./index.js"
}
"recipes": [
{
"from": "node_modules/three/build/three.module.js",
"to": "deps/three.js/index.js"
},
{
"from": "node_modules/three/examples/jsm/webxr/ARButton.js",
"to": "deps/three.js/ARButton.js",
"replace": {
"../../../build/three.module.js": "./index.js"
}
]
}
}
]
}
`;
*/
\ No newline at end of file
......