Skip to content

Commit f97dcc1

Browse files
authored
Update README.md
1 parent 9f22aa4 commit f97dcc1

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -179,16 +179,19 @@ Whatever you can think of. It's an opensource web AR framework for everyone!
179179
#### Directories explained
180180

181181
1. `/src` folder contains majority of the source code
182-
2. `/dist` folder contains the built library
183-
3. `/examples` folder contains examples to test out during development
182+
2. `/examples` folder contains examples to test out during development
184183

185184
#### To create a production build
186185

187-
run `> npm run build`. `mindar-XXX.prod.js` and `mindar-XXX-aframe.propd.js will be generated for each tracking type.
186+
run `> npm run build`. the build will be generated in `dist` folder
188187

189188
#### For development
190189

191-
run `> npm run watch`. This will observe the file changes in `src` folder and continuously build a `mindar-XXX.js` and `mindar-XXX-aframe` inside the `dist-dev` folder. The examples inside the `examples` folder is using this development build. You can open this examples in browser to start debug/development.
190+
To develop threeJS version, run `> npm run watch`. This will observe the file changes in `src` folder and continuously build the artefacts in `dist-dev`.
191+
192+
To develop AFRAME version, you will need to run `>npm run build-dev` everytime you make changes. The `--watch` parameter currently failed to automatically generate `mindar-XXX-aframe.js`.
193+
194+
All the examples in the `examples` folder is configured to use this development build, so you can open those examples in browser to start debugging or development.
192195

193196
The examples should run in desktop browser and they are just html files, so it's easy to start development. However, because it requires camera access, so you need a webcam. Also, you need to run the html file with some localhost web server. Simply opening the files won't work.
194197

0 commit comments

Comments
 (0)