diff --git a/README.md b/README.md index 2d16bc0..b606728 100644 --- a/README.md +++ b/README.md @@ -10,22 +10,57 @@ It can also be used to `extract` out `audio` or `video` from a media file. [![Medipack](https://raw.githubusercontent.com/srbcheema1/medipack/master/extra/medipack-52x90.png)](https://pypi.org/project/medipack/) + ### Installation +#### Install using pip (Recommended) + +- Use pip to install, user `--user` flag +``` +sudo python3 -m pip install medipack +``` + #### Build from Source -- `git clone https://github.com/srbcheema1/medipack` -- `cd medipack` -- `sudo python3 setup.py install` +- Clone the repository and checkout to stable commit +``` +git clone https://github.com/srbcheema1/medipack +cd medipack +git checkout +``` -#### Install using pip +- install requirements +``` +python3 -m pip install --user -r requirements.txt +``` +- Install Medipack +``` +python3 setup.py install --user +``` +#### Verify installation +- check for working ``` -sudo python3 -m pip install medipack +medipack -h +``` +- if it displays help message you are ready to go. + + +#### troubleshooting +- In case `medipack -h` is not working, ensure that binary path is in PATH. +Add line `export PATH=$PATH:"~/.local/bin"` in your `~/.bashrc` or `~/.zshrc`. + +- bash users run these commands +``` +echo export PATH="$PATH":"~/.local/bin" >> ~/.bashrc +source ~/.bashrc +``` +- zsh users run these commands ``` -you may use `--user` option to install locally for user only in `~/.local/bin` -don't forget `~/.local/bin` should be in your `PATH`. Add line `export PATH=$PATH="~/.local/bin"` in your `.bashrc` +echo export PATH="$PATH":"~/.local/bin" >> ~/.zshrc +source ~/.zshrc +``` ### Usage ``` @@ -205,9 +240,10 @@ medipack extract input.mp4 --video ### Contact / Social Media -[![Github](https://raw.githubusercontent.com/srbcheema1/medipack/master/extra/github.png)](https://github.com/srbcheema1/) -[![LinkedIn](https://raw.githubusercontent.com/srbcheema1/medipack/master/extra/linkedin-48x48.png)](https://www.linkedin.com/in/srbcheema1/) -[![Facebook](https://raw.githubusercontent.com/srbcheema1/medipack/master/extra/fb.png)](https://www.facebook.com/srbcheema/) +[![Github](https://raw.githubusercontent.com/srbcheema1/CheemaFy/master/myPlugins/extra_things/png_images/social/github.png)](https://github.com/srbcheema1/) +[![LinkedIn](https://raw.githubusercontent.com/srbcheema1/CheemaFy/master/myPlugins/extra_things/png_images/social/linkedin-48x48.png)](https://www.linkedin.com/in/srbcheema1/) +[![Facebook](https://raw.githubusercontent.com/srbcheema1/CheemaFy/master/myPlugins/extra_things/png_images/social/fb.png)](https://www.facebook.com/srbcheema/) + ### Development by diff --git a/extra/fb.png b/extra/fb.png deleted file mode 100644 index 60233cf..0000000 Binary files a/extra/fb.png and /dev/null differ diff --git a/extra/github.png b/extra/github.png deleted file mode 100644 index fdea4a3..0000000 Binary files a/extra/github.png and /dev/null differ diff --git a/extra/linkedin-48x48.png b/extra/linkedin-48x48.png deleted file mode 100644 index 008bc2c..0000000 Binary files a/extra/linkedin-48x48.png and /dev/null differ