Skip to content

Commit f04b5f1

Browse files
committed
setup instructions and npm scripts
1 parent c819e03 commit f04b5f1

File tree

2 files changed

+18
-2
lines changed

2 files changed

+18
-2
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,20 @@ The autogen solution allows for overriding the default behavior of the generated
1919

2020
The autogen script relies on a json-like config file (`three-class-config.js`) to describe the classes. Reasonable defaults should take care of most, but it allows specifying the base class, constructor args, etc. for each of the wrappers. A base version of this file can be generated by `generate-class-config.js`, but beware, it overwrites any customization to the config file that has already been done.
2121

22+
## Setup
23+
24+
```
25+
# Initial setup
26+
cd js
27+
npm install
28+
29+
# Generate files
30+
npm run autogen
31+
32+
# Clean out generated files
33+
npm run clean
34+
```
35+
2236
List of relevant files:
2337

2438
```
@@ -75,6 +89,8 @@ js/src/examples/renderers/Projector.js
7589
```
7690

7791

92+
TODO: Everything below here is probably outdated.
93+
7894

7995
Installation
8096
------------

js/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
"url": "https://github.com/jovyan/pythreejs.git"
1111
},
1212
"scripts": {
13-
"clean-py": "rm ../pythreejs/{__init__.py, *_autogen.py} ../pythreejs/*/{__init__.py, *_autogen.py}; ../pythreejs/*/*/{*_autogen.py, __init__.py};",
14-
"autogen": "./scripts/generate-wrappers.js",
13+
"clean": "node ./scripts/clean-generated-files.js",
14+
"autogen": "node ./scripts/generate-wrappers.js",
1515
"build": "webpack",
1616
"prepublish": "webpack",
1717
"test": "echo \"Error: no test specified\" && exit 1"

0 commit comments

Comments
 (0)