@a2f0/skyline 0.2.48 → 0.2.49
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -11
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,21 +3,21 @@
|
|
|
3
3
|
A grayscale Chicago skyline traced from a 2013 photograph taken on the lakefront by the Adler
|
|
4
4
|
Planetarium, and a 3D city of 34 mapped buildings seen through that photograph's own camera.
|
|
5
5
|
Hover a building for its name, right-click it for a close look, or switch to the animated drawing
|
|
6
|
-
it was fitted to.
|
|
6
|
+
it was fitted to. This repo is available on the web at <https://skyline.devopsrockstars.com>.
|
|
7
7
|
|
|
8
|
-
##
|
|
8
|
+
## Quick start
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
Install [mise](https://mise.jdx.dev/) and Python 3, which serves the built site:
|
|
11
11
|
|
|
12
12
|
```sh
|
|
13
13
|
mise install # Bun and Node from mise.toml
|
|
14
14
|
bun install --ignore-scripts
|
|
15
|
+
bun run hooks:install # Git hooks, once per clone
|
|
15
16
|
bun run build:site
|
|
16
|
-
python3 -m http.server -d dist
|
|
17
|
+
python3 -m http.server -d dist # http://localhost:8000
|
|
17
18
|
```
|
|
18
19
|
|
|
19
|
-
|
|
20
|
-
WebGL and the 3D pages need it.
|
|
20
|
+
Serve `dist/` over HTTP rather than opening files directly: WebGL and the 3D pages need it.
|
|
21
21
|
|
|
22
22
|
## Pages
|
|
23
23
|
|
|
@@ -34,14 +34,14 @@ WebGL and the 3D pages need it.
|
|
|
34
34
|
|
|
35
35
|
The repository also builds [`@a2f0/skyline`](https://www.npmjs.com/package/@a2f0/skyline), an ESM
|
|
36
36
|
package that mounts the complete viewer into a host page's own document, in a shadow root, with
|
|
37
|
-
reusable Three.js scenes and building models, and TypeScript declarations. Every merge to `main`
|
|
38
|
-
`bun run build:package` or `bun pm pack` to build it locally.
|
|
39
|
-
covers installing, asset copying, mounting, imports, and
|
|
37
|
+
reusable Three.js scenes and building models, and TypeScript declarations. Every merge to `main`
|
|
38
|
+
publishes a new version to npm; run `bun run build:package` or `bun pm pack` to build it locally.
|
|
39
|
+
[The package guide](docs/package.md) covers installing, asset copying, mounting, imports, and
|
|
40
|
+
releases.
|
|
40
41
|
|
|
41
42
|
## Development
|
|
42
43
|
|
|
43
44
|
```sh
|
|
44
|
-
bun run hooks:install # once per clone
|
|
45
45
|
bun run check # typecheck, unit and browser suites; needs Google Chrome
|
|
46
46
|
bun run deploy # publish to Cloudflare; needs Node.js 22+ and wrangler login
|
|
47
47
|
```
|
|
@@ -51,6 +51,5 @@ bun run deploy # publish to Cloudflare; needs Node.js 22+ and
|
|
|
51
51
|
(`ln -s ../matrix-secrets/skyline .secrets`) that Terraform reads its Cloudflare and R2 state
|
|
52
52
|
credentials through. To add a building or improve one, start with
|
|
53
53
|
[Adding a building](docs/adding-a-building.md) or the [fidelity queue](docs/building-fidelity.md).
|
|
54
|
-
Coding agents follow [`AGENTS.md`](AGENTS.md).
|
|
55
54
|
|
|
56
55
|
All documentation is indexed in [`docs/`](docs/README.md).
|