8000 fix readme · devforth/scriptimate@02bd6ca · GitHub
[go: up one dir, main page]

Skip to content

Commit 02bd6ca

Browse files
committed
fix readme
1 parent 49231a2 commit 02bd6ca

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

readme.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,21 @@ Create webm/mp4/gif videos by animating qualitative SVG files (e.g. exported fro
44

55
> ⚠️ for now Supported Node version is 16+ (Probably 14, but 12 is not working)
66
7+
Works on on 🪟Windows WSL 2 🐧Ubuntu 🍏Mac
78
## Build performance
89

910
🪧 Scriptimate uses `/tmp` to store build cache, so to improve build speed even more, make sure `/tmp` is mounted on RAM in `/etc/fstab`
1011

11-
> ⚠️ If you made changes out of project sources (e.g. updated sytem font and re-built video), and see there are no updates in results, please use no cache parameter (`-nc`)
12-
1312
```
1413
tmpfs /tmp tmpfs nosuid,nodev,noatime 0 0
1514
```
1615

1716

18-
## Typical example
17+
> ⚠️ If you made changes out of project sources (e.g. updated sytem font and re-built video), and see there are no updates in results, please use no cache parameter (`-nc`)
1918
2019

20+
## Typical example
21+
2122
Create text file `demo.smte`:
2223

2324
```
@@ -52,26 +53,16 @@ sudo apt install libnss3-dev libatk-bridge2.0-0 libcups2 libgtk-3-0 libgbm-dev f
5253

5354
Required version of `ffmpeg >=4.x` (Will be installed automatically in Ubuntu 20.04+, when in 18.04 it will be 3.x, which is not compatible)
5455

55-
If you are using custom changable texts, please make sure you have all fonts installed into os which you use, e.g. on Ubuntu:
56+
If you are using custom changable texts, please make sure you have all fonts that you use in styles installed into OS, e.g. on Ubuntu:
5657

5758
```
5859
sudo apt install fonts-roboto fonts-open-sans
5960
```
6061

61-
## Hello world example
62+
## Getting started
6263

6364
Read here: https://tracklify.com/blog/scriptimate-an-open-source-tool-to-create-svg-animations-in-a-coding-way/
6465

65-
# Development
66-
67-
Just do:
68-
69-
```
70-
npm ci
71-
cd examples
72-
node ../bin/scriptimate.js -i 7_dashoffset.smte -f gif
73-
```
74-
7566

7667
## How to run examples from this repo
7768

@@ -259,6 +250,17 @@ Used to draw strokes. Added by [@maxm123](https://github.com/maxm123)
259250
dashoffset <svg name> <[optional] mode> <target dashoffset>
260251
```
261252

253+
254+
# Development
255+
256+
Just do:
257+
258+
```
259+
npm ci
260+
cd examples
261+
node ../bin/scriptimate.js -i 7_dashoffset.smte -f gif
262+
```
263+
262264
## Known bugs and improvements
263265

264266
* HTML Pages gen xx% shows more then 100% if run_groups_together is used. Only visual status bug, compiled video is correct

0 commit comments

Comments
 (0)
0