Go to file
AlfredoSequeida 2686b7bf04 cleaned up code 2020-10-07 05:22:23 -07:00
.gitignore adding git ignore to keep unwanted files out 2020-10-06 14:53:13 -04:00
README.md added readme 2020-10-07 05:21:46 -07:00
fvid.py cleaned up code 2020-10-07 05:22:23 -07:00

README.md

Venus: For those that get bored of looking at their wallpaper

Maintenance PyPI license

venus

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 tag for issues that should be ideal for people who are not very familiar with the codebase yet.
  2. Fork the repository 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. :)