asciianything 1.1.3 → 1.1.5

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.
Files changed (2) hide show
  1. package/README.md +22 -50
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -9,7 +9,6 @@
9
9
  [![Watchers](https://img.shields.io/github/watchers/sloemo01/asciianything?style=flat-square&color=1d1d1f&label=watchers)](https://github.com/sloemo01/asciianything/watchers)
10
10
  [![License](https://img.shields.io/github/license/sloemo01/asciianything?style=flat-square&color=1d1d1f)](LICENSE)
11
11
  [![npm](https://img.shields.io/npm/v/asciianything?style=flat-square&color=1d1d1f&logo=npm&logoColor=white)](https://www.npmjs.com/package/asciianything)
12
- [![downloads](https://img.shields.io/npm/dm/asciianything?style=flat-square&color=1d1d1f&label=downloads)](https://www.npmjs.com/package/asciianything)
13
12
  [![node](https://img.shields.io/badge/node-%E2%89%A518-1d1d1f?style=flat-square)](package.json)
14
13
 
15
14
  <p>
@@ -49,46 +48,26 @@ A small Node CLI around a deterministic renderer.
49
48
 
50
49
  ## Install it
51
50
 
52
- Paste this into an agent that can run shell commands. It asks where the copy should live, clones the repository, installs
53
- the dependency, renders a test frame and reports what it measured before it renders anything for you. The published
54
- package is the same code, so the agent can work from either.
51
+ Paste this into an agent that can run shell commands. It installs the published package, proves it on a still, and
52
+ reports what it measured before rendering anything for you.
55
53
 
56
54
  ```text
57
- Install asciianything here, then use it to render a video.
58
-
59
- Repo: https://github.com/sloemo01/asciianything
60
-
61
- 1. Ask me where the folder should go before downloading anything,
62
- and wait for my answer. Propose ~/tools/asciianything as the default.
63
- Do not pick a path silently.
64
- 2. Download the whole repository, not just the README:
65
- git clone https://github.com/sloemo01/asciianything.git "<target>"
66
- Without git:
67
- curl -L -o asciianything.tar.gz \
68
- https://github.com/sloemo01/asciianything/archive/main.tar.gz
69
- tar xzf asciianything.tar.gz && mv asciianything-main "<target>"
70
- 3. Install and prove it:
71
- cd "<target>" && npm ci
72
- node src/cli.js --help
73
- node src/cli.js assets/night-highway-1080p.mp4 --still 8 \
74
- --font-size 10 --calibration 0.76 --halo 1.2 --halo-radius 8 \
75
- -o /tmp/proof.png
76
- Print the commit hash (git -C "<target>" rev-parse --short HEAD), the
77
- grid size the CLI reports, and the size of /tmp/proof.png. If npm ci,
78
- ffmpeg, or the still fails, say so and stop. Never describe this tool
79
- from memory.
80
- 4. Check the machine has ffmpeg and ffprobe on PATH; if not, tell me the
81
- install command for my platform and stop.
82
- 5. Report back in this order: install path and commit, the grid and glyph
83
- settings, the encoder flags, and three rules from "How it works" with
84
- the section each came from.
85
- 6. Then ask me for the video to convert, and for the font size. Ask once;
86
- do not interview me. Render it, probe the output with ffprobe, and show
87
- me the frame count, duration and resolution next to the source's.
55
+ Install asciianything from npm, verify it, then render a video.
56
+
57
+ 1. Confirm node 18+ and ffmpeg/ffprobe are on PATH. If either is missing, give
58
+ me the install command for my platform and stop.
59
+ 2. npm i -g asciianything (one-off runs also work with npx asciianything)
60
+ 3. Prove it before describing it:
61
+ asciianything --help
62
+ asciianything <any.mp4> --still 8 -o /tmp/proof.png
63
+ Print the version, the grid the CLI reports and the size of proof.png. If a
64
+ step fails, say so and stop. Never describe the tool from memory.
65
+ 4. Report in this order: version, grid and glyph size, encoder flags, then three
66
+ rules from "How it works" with the section each came from.
67
+ 5. Ask me for the video and the font size once, render it, and probe the output
68
+ with ffprobe next to the source: frames, duration, resolution.
88
69
  ```
89
70
 
90
- Or skip the repository entirely:
91
-
92
71
  ```bash
93
72
  npx asciianything night-drive.mp4 # one clip, no install
94
73
  npm i -g asciianything # or keep it on PATH
@@ -99,19 +78,12 @@ Node 18+ and `ffmpeg` / `ffprobe` are the only requirements.
99
78
  ### Update it
100
79
 
101
80
  ```text
102
- Update my asciianything install, then report what changed.
103
-
104
- 1. Ask me for the folder before touching anything, and wait.
105
- 2. Print the current commit, then make the update reversible:
106
- git -C "<target>" rev-parse --short HEAD
107
- git -C "<target>" diff > my-changes.patch
108
- cp -R "<target>" "<target>.bak"
109
- 3. Pull the latest main:
110
- git -C "<target>" pull --ff-only
111
- cd "<target>" && npm ci
112
- 4. Diff the CLI help and the README changelog before and after, and tell
113
- me what new flags or defaults appeared. Do not re-render anything yet.
114
- 5. If the build or a test still fails, restore "<target>.bak" and say so.
81
+ Update asciianything, then report what changed.
82
+
83
+ 1. Print the current version and --help.
84
+ 2. npm i -g asciianything@latest
85
+ 3. Diff the old and new --help, list new flags or changed defaults, and stop
86
+ before re-rendering anything. If the install fails, say so.
115
87
  ```
116
88
 
117
89
  ## Run it
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "asciianything",
3
- "version": "1.1.3",
3
+ "version": "1.1.5",
4
4
  "description": "Turn any video into a mosaic of coloured lowercase prose, frame-accurate, with ffmpeg.",
5
5
  "keywords": [
6
6
  "ascii",