fosdem-recorder.rb/README.md

57 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2021-02-07 13:40:32 +00:00
# FOSDEM Recorder
2022-08-21 13:50:17 +00:00
:turning_light: This project has been discontinued. It was replaced with [fosdem-recorder.cr](#FIXME).
2021-02-07 13:40:32 +00:00
## Prerequisites
2021-02-07 20:45:08 +00:00
* Make sure you have a recent Ruby version installed
2021-02-07 13:40:32 +00:00
* Make sure you have the 'bundler' Gem installed
2021-02-07 20:45:08 +00:00
2021-02-07 13:40:32 +00:00
## Installation
Install project dependencies
$ bundle install
2021-02-07 20:45:08 +00:00
2021-02-07 13:40:32 +00:00
## Usage
Get information about given URL
2021-02-07 20:45:08 +00:00
$ fosdem_recorder info URL
2021-02-07 13:40:32 +00:00
Schedule video download for given URL
2021-02-07 20:45:08 +00:00
$ fosdem_recorder download URL
2021-02-07 13:40:32 +00:00
Real example
```shell-session
$ bundle exec fosdem-recorder info https://fosdem.org/2021/schedule/event/sca_weclome/
* title = FOSDEM 2021 - Software Composition Analysis Devroom Welcome
* start = 14:00
* stop = 14:05
* diff = 00:05:00
* url = https://stream.fosdem.org/dcomposition.m3u8
$ bundle exec fosdem-recorder info https://fosdem.org/2021/schedule/event/sca_weclome/
2021-02-07 20:45:08 +00:00
[... schedules the download with 'at'... ]
[... downloads the file with 'ffmpeg'... ]
2021-02-07 13:40:32 +00:00
[... a MP4 file will be created once the video is downloaded ...]
```
2021-02-07 20:41:13 +00:00
## Development
After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
## Contributing
2021-02-07 20:45:08 +00:00
Bug reports and pull requests are welcome on GitHub at https://github.com/glenux/fosdem-recorder.