asciianything 1.1.4 → 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 -49
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -48,46 +48,26 @@ A small Node CLI around a deterministic renderer.
48
48
 
49
49
  ## Install it
50
50
 
51
- Paste this into an agent that can run shell commands. It asks where the copy should live, clones the repository, installs
52
- the dependency, renders a test frame and reports what it measured before it renders anything for you. The published
53
- 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.
54
53
 
55
54
  ```text
56
- Install asciianything here, then use it to render a video.
57
-
58
- Repo: https://github.com/sloemo01/asciianything
59
-
60
- 1. Ask me where the folder should go before downloading anything,
61
- and wait for my answer. Propose ~/tools/asciianything as the default.
62
- Do not pick a path silently.
63
- 2. Download the whole repository, not just the README:
64
- git clone https://github.com/sloemo01/asciianything.git "<target>"
65
- Without git:
66
- curl -L -o asciianything.tar.gz \
67
- https://github.com/sloemo01/asciianything/archive/main.tar.gz
68
- tar xzf asciianything.tar.gz && mv asciianything-main "<target>"
69
- 3. Install and prove it:
70
- cd "<target>" && npm ci
71
- node src/cli.js --help
72
- node src/cli.js assets/night-highway-1080p.mp4 --still 8 \
73
- --font-size 10 --calibration 0.76 --halo 1.2 --halo-radius 8 \
74
- -o /tmp/proof.png
75
- Print the commit hash (git -C "<target>" rev-parse --short HEAD), the
76
- grid size the CLI reports, and the size of /tmp/proof.png. If npm ci,
77
- ffmpeg, or the still fails, say so and stop. Never describe this tool
78
- from memory.
79
- 4. Check the machine has ffmpeg and ffprobe on PATH; if not, tell me the
80
- install command for my platform and stop.
81
- 5. Report back in this order: install path and commit, the grid and glyph
82
- settings, the encoder flags, and three rules from "How it works" with
83
- the section each came from.
84
- 6. Then ask me for the video to convert, and for the font size. Ask once;
85
- do not interview me. Render it, probe the output with ffprobe, and show
86
- 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.
87
69
  ```
88
70
 
89
- Or skip the repository entirely:
90
-
91
71
  ```bash
92
72
  npx asciianything night-drive.mp4 # one clip, no install
93
73
  npm i -g asciianything # or keep it on PATH
@@ -98,19 +78,12 @@ Node 18+ and `ffmpeg` / `ffprobe` are the only requirements.
98
78
  ### Update it
99
79
 
100
80
  ```text
101
- Update my asciianything install, then report what changed.
102
-
103
- 1. Ask me for the folder before touching anything, and wait.
104
- 2. Print the current commit, then make the update reversible:
105
- git -C "<target>" rev-parse --short HEAD
106
- git -C "<target>" diff > my-changes.patch
107
- cp -R "<target>" "<target>.bak"
108
- 3. Pull the latest main:
109
- git -C "<target>" pull --ff-only
110
- cd "<target>" && npm ci
111
- 4. Diff the CLI help and the README changelog before and after, and tell
112
- me what new flags or defaults appeared. Do not re-render anything yet.
113
- 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.
114
87
  ```
115
88
 
116
89
  ## Run it
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "asciianything",
3
- "version": "1.1.4",
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",