Skip to content

Commit feb1565

Browse files
committed
Update README
1 parent f1dbe27 commit feb1565

File tree

1 file changed

+7
-64
lines changed

1 file changed

+7
-64
lines changed

README.md

Lines changed: 7 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -42,77 +42,20 @@ The autogen script relies on a json-like config file (`three-class-config.js`) t
4242

4343
#### Setup
4444

45+
The relevant commands while working on the repository are included below. These are not meant to be run sequentially, but rather as a list of useful commands:
46+
4547
```bash
46-
# Initial setup
47-
cd js
48-
npm install
48+
# To perform initial dev setup, run:
49+
pip install -e .
4950

50-
# Generate files
51+
# To re-generate autogen files, run:
5152
npm run autogen
52-
pip install -e .
5353

54-
# Build distribution files
54+
# To build and install distribution files, run:
5555
npm run build
5656
jupyter nbextension install --py --symlink --sys-prefix pythreejs
5757

58-
# Clean out generated files
58+
# To clean out generated files, run:
5959
npm run clean
6060

6161
```
62-
63-
List of relevant files:
64-
65-
```bash
66-
js/package.json
67-
js/webpack.config.js
68-
69-
# Files for auto-generation
70-
js/scripts/*
71-
72-
# New bases classes for supporting wrapper classes
73-
js/src/_base/*
74-
pythreejs/_base/Three.py
75-
pythreejs/enums.py
76-
pythreejs/traits.py
77-
78-
# Overridden classes
79-
js/src/core/Object3D.js
80-
js/src/cameras/OrthographicCamera.js
81-
js/src/cameras/PerspectiveCamera.js
82-
js/src/controls/OrbitControls.js
83-
js/src/controls/TrackballControls.js
84-
js/src/controls/FlyControls.js
85-
js/src/controls/Picker.js
86-
js/src/textures/DataTexture.js
87-
js/src/textures/DepthTexture.js
88-
js/src/renderers/WebGLRenderer.js
89-
90-
pythreejs/core/Object3D.py
91-
pythreejs/renderers/WebGLRenderer.py
92-
93-
# Custom classes
94-
js/src/core/Renderer.js
95-
js/src/textures/ImageTexture.js # created to ease image texture loading
96-
js/src/textures/ImageTexture.js # created to ease image texture loading
97-
js/src/textures/TextTexture.js # created to ease creation of textures of rasterized text
98-
js/src/geometry/PlainGeometry.js # created to not auto-sync geometry data of generated geometry
99-
pythreejs/core/Renderer.py
100-
101-
102-
# Updated examples notesbooks
103-
examples/Examples.ipynb
104-
examples/Geometries.ipynb
105-
examples/Textures.ipynb
106-
examples/renderer_limit.ipynb
107-
examples/test.ipynb
108-
examples/img/checkerboard.png
109-
examples/img/earth.jpg
110-
111-
# Pulled in latest version of examples files from three.js source
112-
js/src/examples/Detector.js
113-
js/src/examples/controls/MomentumCameraControls.js
114-
js/src/examples/controls/OrbitControls.js
115-
js/src/examples/controls/TrackballControls.js
116-
js/src/examples/renderers/CanvasRenderer.js
117-
js/src/examples/renderers/Projector.js
118-
```

0 commit comments

Comments
 (0)