Helper tool for stitching together livestream VOD segments and uploading them to YouTube!
update README
+11
-5
+11
-5
README.md
+11
-5
README.md
···
14
14
$ vodular
15
15
New config file created (config.toml). Please edit this file before running again!
16
16
```
17
+
The directory which holds your configuration file and templates varies,
18
+
depending on platform:
19
+
- **Linux:** `~/.config/vodular/templates`
20
+
- **macOS:** `~/Library/Application Support/vodular/templates`
21
+
- **Windows:** `%AppData%/vodular/templates`
17
22
18
-
2. Edit configuration file as necessary (You will need to create a [YouTube Data API v3](https://developers.google.com/youtube/v3) service and provide its credentials here).
23
+
2. Edit your configuration file as necessary (You will need to create a [YouTube Data API v3](https://developers.google.com/youtube/v3) service and provide its credentials here).
19
24
**IMPORTANT:** `config.toml` contains very sensitive credentials. Do not share this file with anyone.
20
25
21
26
3. Initialise a VOD directory:
···
63
68
```
64
69
65
70
## Templates
66
-
Template files can be created at `templates/title.txt`,
67
-
`template/description.txt`, and `templates/tags.txt` respectively. These
68
-
files can use Go's [text template format](https://pkg.go.dev/text/template) to
69
-
customise VOD metadata on upload.
71
+
There are three template files, `title.txt`, `description.txt`, and `tags.txt`,
72
+
which can be created in `/path/to/vodular/templates`. These templates can be
73
+
created and tweaked to customise your VOD metadata on upload. They are enhanced
74
+
with Go's [template format](https://pkg.go.dev/text/template) to inject
75
+
information provided in `metadata.toml`, and other neat functionality!
70
76
71
77
You can use the following data in templates:
72
78
- **`.Title`:** The title of the stream.