forked from forks/ffprobe-wasm
Add readme and license.
This commit is contained in:
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2020 Alfred Gutierrez
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
52
README.md
Normal file
52
README.md
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
# `FFProbe Web Analyzer`
|
||||||
|
> A Web-based FFProbe. Powered by FFmpeg, Vue and Web Assembly! 🦀.
|
||||||
|
|
||||||
|
https://alfg.github.io/ffprobe-web-analyzer/
|
||||||
|
|
||||||
|
⚠️ Currently functional, but a work-in-progress! Check back for updates!
|
||||||
|
|
||||||
|
## Development
|
||||||
|
`ffprobe-web-analyzer` uses [emscripten](https://emscripten.org/) to compile [FFmpeg](https://ffmpeg.org)'s [libav](https://ffmpeg.org/doxygen/4.1/index.html) to [Web Assembly](https://webassembly.org/) via [Docker](https://www.docker.com/).
|
||||||
|
|
||||||
|
Emscripten is also used to create and compile the Wasm bindings to be imported by the browser.
|
||||||
|
|
||||||
|
### Requirements
|
||||||
|
* `nodejs` - https://nodejs.org/en/download/
|
||||||
|
* `docker` - https://docs.docker.com/desktop/
|
||||||
|
|
||||||
|
### Setup
|
||||||
|
* Clone project and build the Wasm module via Docker:
|
||||||
|
```
|
||||||
|
docker-compose run ffprobe-web-analyzer make
|
||||||
|
```
|
||||||
|
|
||||||
|
This will build the WASM module and place it into the `/dist` folder.
|
||||||
|
|
||||||
|
* Install and run web:
|
||||||
|
```
|
||||||
|
cd www
|
||||||
|
npm install
|
||||||
|
npm run serve
|
||||||
|
```
|
||||||
|
|
||||||
|
* Load `http://localhost:8080/` in the web browser.
|
||||||
|
|
||||||
|
### Compiles and minifies for production
|
||||||
|
```
|
||||||
|
npm run build
|
||||||
|
```
|
||||||
|
|
||||||
|
### Deploy
|
||||||
|
Deploys to [Github Pages](https://pages.github.com/)
|
||||||
|
```
|
||||||
|
npm run deploy
|
||||||
|
```
|
||||||
|
|
||||||
|
### Resources
|
||||||
|
* https://ffmpeg.org/doxygen/4.1/index.html
|
||||||
|
* https://emscripten.org/
|
||||||
|
* https://vuejs.org
|
||||||
|
* https://bootstrap-vue.org
|
||||||
|
|
||||||
|
## License
|
||||||
|
MIT
|
||||||
Reference in New Issue
Block a user