Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
srbcheema1 committed Nov 4, 2018
1 parent cef4294 commit 423c580
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 10 deletions.
56 changes: 46 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <latest_version say: v0.0.x>
```

#### 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

```
Expand Down Expand Up @@ -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

Expand Down
Binary file removed extra/fb.png
Binary file not shown.
Binary file removed extra/github.png
Binary file not shown.
Binary file removed extra/linkedin-48x48.png
Binary file not shown.

0 comments on commit 423c580

Please sign in to comment.