Skip to content

Commit f2878bc

Browse files
committed
docs: update readme + patch notes
1 parent de2a7d6 commit f2878bc

File tree

5 files changed

+26
-18
lines changed

5 files changed

+26
-18
lines changed

Makefile

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,12 +143,14 @@ re: fclean
143143
.PHONY: debug
144144
debug: fclean
145145
$(MAKE) "CXXFLAGS = $(CXXFLAGS) -g3"
146+
# $(MAKE) "CXXFLAGS = $(CXXFLAGS) -g3" "CPPFLAGS = $(CPPFLAGS) -fsanitize=address" "LDFLAGS = $(LDFLAGS) -fsanitize=address"
146147

147148

148149
.PHONY: format
149150
format:
150151
clang-format -i **/*.cpp **/*.hpp
151152

152-
.PHONY: doc
153-
doc:
153+
.PHONY: docs
154+
docs:
155+
./vc --generate
154156
./docs/readme/generate.sh

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,26 @@ Below is an example of the last feature added (code) and the result (video).
1616
from videocode.VideoCode import *
1717

1818
x = 700
19-
y = 100
19+
y = 10
2020

2121
# text: Video-Code
2222
t = text("Video-Code", 3).apply(translate(x, y), repeat(40))
2323
t[:20].apply(fadeIn())
24-
t[20:].apply(fadeOut())
2524
t.add()
25+
t.keep()
2626

27-
# text: Made by:
28-
t = text("made by", 3).apply(translate(x, y), repeat(40))
27+
# text: Made by
28+
t = text("made by", 3).apply(translate(x, y + 80), repeat(40))
2929
t[:20].apply(fadeIn())
30-
t[20:].apply(fadeOut())
3130
t.add()
31+
t.keep()
3232

3333

3434
# Me
35-
v = video("video/v.mp4").apply(translate(x, y + 100))
36-
v[0:20].apply(fadeIn()).add()
37-
v[20:40].apply(fadeOut()).add()
35+
v = video("video/v.mp4").apply(translate(x, y + 175))
36+
v[0:20].apply(fadeIn())
37+
v.add()
38+
v.keep()
3839
```
3940

4041
<img src="docs/readme/example.gif" style="width: 50%;">
@@ -87,6 +88,8 @@ To add the frames of the __Input__ to the timeline, use the __\<Input\>.add()__
8788
<summary><code>Patchs</code></summary>
8889
<br>
8990

91+
- `feature`: keep last frame of input on screen (06/03/25)
92+
- `rework`: one stack (06/03/25)
9093
- `transformation`: repeat (03/03/25)
9194
- `input`: text (03/03/25)
9295
- `rework`: position of the frames (02/03/25)

docs/readme/02_code.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,24 @@
33
from videocode.VideoCode import *
44

55
x = 700
6-
y = 100
6+
y = 10
77

88
# text: Video-Code
99
t = text("Video-Code", 3).apply(translate(x, y), repeat(40))
1010
t[:20].apply(fadeIn())
11-
t[20:].apply(fadeOut())
1211
t.add()
12+
t.keep()
1313

14-
# text: Made by:
15-
t = text("made by", 3).apply(translate(x, y), repeat(40))
14+
# text: Made by
15+
t = text("made by", 3).apply(translate(x, y + 80), repeat(40))
1616
t[:20].apply(fadeIn())
17-
t[20:].apply(fadeOut())
1817
t.add()
18+
t.keep()
1919

2020

2121
# Me
22-
v = video("video/v.mp4").apply(translate(x, y + 100))
23-
v[0:20].apply(fadeIn()).add()
24-
v[20:40].apply(fadeOut()).add()
22+
v = video("video/v.mp4").apply(translate(x, y + 175))
23+
v[0:20].apply(fadeIn())
24+
v.add()
25+
v.keep()
2526
```

docs/readme/05_patch_notes.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@
3737
<summary><code>Patchs</code></summary>
3838
<br>
3939

40+
- `feature`: keep last frame of input on screen (06/03/25)
41+
- `rework`: one stack (06/03/25)
4042
- `transformation`: repeat (03/03/25)
4143
- `input`: text (03/03/25)
4244
- `rework`: position of the frames (02/03/25)

docs/readme/example.gif

2.15 MB
Loading

0 commit comments

Comments
 (0)