mirror of https://github.com/AlfredoSequeida/fvid
added readme
This commit is contained in:
parent
0ed8722183
commit
69b3cb9894
|
@ -0,0 +1,61 @@
|
|||
Venus: For those that get bored of looking at their wallpaper
|
||||
===============================================================
|
||||
|
||||
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)
|
||||
[![PyPI license](https://img.shields.io/pypi/l/ansicolortags.svg)](https://pypi.python.org/pypi/ansicolortags/)
|
||||
|
||||
|
||||
<p align="center">
|
||||
<img src="https://i.imgur.com/KqmTZFI.png" alt="venus">
|
||||
</br>
|
||||
</p>
|
||||
|
||||
fvid is a project that aims to encode any file as a video using 1-bit color images
|
||||
to survive compression algorithms for data retrieval.
|
||||
|
||||
---
|
||||
|
||||
|
||||
# Usage
|
||||
|
||||
Encoding files as videos
|
||||
|
||||
Linux/OSX
|
||||
|
||||
```
|
||||
fvid -i [input file] -e
|
||||
```
|
||||
|
||||
Windows
|
||||
|
||||
```
|
||||
py -m fvid -i [input file] -e
|
||||
```
|
||||
|
||||
Retrieving data from videos
|
||||
|
||||
Linux/OSX
|
||||
|
||||
```
|
||||
fvid -i [input video] -d
|
||||
```
|
||||
|
||||
Windows
|
||||
|
||||
```
|
||||
py -m fvid -i [input video] -d
|
||||
```
|
||||
|
||||
|
||||
How to Contribute
|
||||
-----------------
|
||||
|
||||
1. Check for open issues or open a fresh issue to start a discussion
|
||||
around a feature idea or a bug [here](https://github.com/AlfredoSequeida/fvid/issues)
|
||||
tag for issues that should be ideal for people who are not very familiar with the codebase yet.
|
||||
2. Fork [the repository](https://github.com/alfredosequeida/fvid) on
|
||||
GitHub to start making your changes to the **master** branch (or branch off of it).
|
||||
3. Write a test which shows that the bug was fixed or that the feature
|
||||
works as expected.
|
||||
4. Send a pull request and bug the maintainer until it gets merged and
|
||||
published. :)
|
Loading…
Reference in New Issue