Skip to content

Commit 9c8f36d

Browse files
committed
Update README.md
1 parent 8df7c5b commit 9c8f36d

File tree

1 file changed

+55
-63
lines changed

1 file changed

+55
-63
lines changed

README.md

Lines changed: 55 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -7,42 +7,62 @@
77

88
**VideoMorph** is a **video converter** based on [ffmpeg](http://ffmpeg.org), and written with [Python](https://python.org) 3, and [PyQt5](https://www.riverbankcomputing.com/static/Docs/PyQt5/introduction.html). With VideoMorph you can convert your favorite videos to the currently more popular video formats, like **MPG**, **MP4**, **AVI**, **WEBM**, **DVD**, **VCD**, **FLV**, **MOV**, **OGV**, **WMV**, **MKV** and also extract the audio to a file with **MP3** or **OGA** formats.
99

10-
VideoMorph is a video converter, just that. Consists on a GUI wrapper for [Ffmpeg](http://ffmpeg.org), based on general ideas from [python-video-converter](https://github.com/senko/python-video-converter), and presets idea from [QWinFF](http://qwinff.github.io). If you're looking for a video editor, we really sorry but VideoMorph isn't for you.
10+
VideoMorph is a video converter, just that. Consists on a GUI wrapper for [Ffmpeg](http://ffmpeg.org), based on general ideas from [python-video-converter](https://github.com/senko/python-video-converter), and presets idea from [QWinFF](http://qwinff.github.io). If you're looking for a video editor, we're sorry but VideoMorph isn't for you.
11+
12+
- [VideoMorph](#videomorph)
13+
- [GUI Screenshot](#gui-screenshot)
14+
- [Requirements](#requirements)
15+
- [Installation](#installation)
16+
- [Installing From the Binary Packages](#installing-from-the-binary-packages)
17+
- [On GNU/Linux](#on-gnulinux)
18+
- [On Windows](#on-windows)
19+
- [Installing Form the Source Packages](#installing-form-the-source-packages)
20+
- [On GNU/Linux](#on-gnulinux-1)
21+
- [On Windows](#on-windows-1)
22+
- [Using Portable Editions (if available)](#using-portable-editions-if-available)
23+
- [How to Contribute to the Source](#how-to-contribute-to-the-source)
24+
- [Setting up the Development Environment](#setting-up-the-development-environment)
25+
- [Commits](#commits)
26+
- [Internal Contributions Procedure](#internal-contributions-procedure)
27+
- [External Contributions Procedure](#external-contributions-procedure)
28+
- [Branch Naming Conventions](#branch-naming-conventions)
29+
- [Coding, and Docstrings Style](#coding-and-docstrings-style)
30+
- [Commit Messaging Style](#commit-messaging-style)
31+
- [Licensing](#licensing)
32+
- [Authors and Contributors](#authors-and-contributors)
33+
- [Copyright](#copyright)
1134

1235
## GUI Screenshot
1336

1437
![Screenshot](screenshot.png)
1538

1639
## Requirements
1740

18-
VideoMorph uses the following libraries, and programs:
41+
VideoMorph uses the following libraries and programs:
1942

2043
- [PyQt5](https://www.riverbankcomputing.com/static/Docs/PyQt5/introduction.html)
21-
2244
- [FFmpeg](http://ffmpeg.org)
23-
2445
- [Python](https://python.org) > 3.4
2546

26-
You need to install these programs, and libraries for VideoMorph to work properly.
47+
You need to install these programs and libraries for VideoMorph to work properly.
2748

2849
On Windows systems, you also need:
2950

30-
- [setuptools](https://pypi.python.org/pypi/setuptools)
51+
- [setuptools](https://pypi.python.org/pypi/setuptools)
3152

3253
## Installation
3354

34-
You can install and use VideoMorph on GNU/Linux and on Windows systems. There are several ways you can use to install the application. Let's take a look at them. We haven't tried properly **yet** on MacO :-|
55+
You can install and use VideoMorph on GNU/Linux and Windows systems. There are several ways you can use to install the application. Let's take a look at them. We haven't tried properly **yet** on MacO :-|
3556

3657
### Installing From the Binary Packages
3758

38-
If you're using GNU/Linux or Windows, then you can install VideoMorph by using the binary package for your current system.
59+
If you're using GNU/Linux or Windows, then you can install VideoMorph by using the appropriate binary package for your system.
3960

4061
#### On GNU/Linux
4162

4263
You can install VideoMorph on Debian/Ubuntu and derivatives by running the following steps:
4364

4465
1. Download the `.deb` package
45-
4666
2. Open a terminal, and run the following commands as **root** or using **sudo**:
4767

4868
```bash
@@ -60,9 +80,7 @@ You can also install VideoMorph's `.deb` package, by using GDebi, which is a GUI
6080
To install VideoMorph on your Windows system, you can:
6181

6282
1. Download the installer that corresponds to your architecture
63-
64-
2. Run the installer as `administrator`
65-
83+
2. Run the installer as an `administrator`
6684
3. Follow on-screen instructions
6785

6886
### Installing Form the Source Packages
@@ -74,7 +92,6 @@ You can install VideoMorph from the source packages. Let's take a look at how to
7492
To install the application from the source package on a GNU/Linux system, do the following:
7593

7694
1. Download the `.tar.gz` package
77-
7895
2. Open a terminal, and run the following commands as **root** or using **sudo **when specified (as in step 3 and 5):
7996

8097
```bash
@@ -96,7 +113,7 @@ $ which ffprobe
96113
/usr/bin/ffprobe
97114
```
98115

99-
If you don't get a similar output, then you need to check your Ffmpeg intallation.
116+
If you don't get a similar output, then you need to check your Ffmpeg installation.
100117

101118
On Debian/Ubuntu derivatives, you can also install VideoMorph by using the `install.sh` script provided in the source package as **root** or using **sudo**:
102119

@@ -106,15 +123,14 @@ $ cd videomorph-x.x
106123
$ sudo ./install.sh
107124
```
108125

109-
This command will install VideoMorph, and its dependencies, (Ffmpeg, and PyQt5), from your distro's current repository.
126+
This command will install VideoMorph and its dependencies (Ffmpeg, and PyQt5) from your distro's current repository.
110127

111128
#### On Windows
112129

113-
To install VideoMorph from the source package on your Windows system, first ensure you have Python3 installed and then you need to:
130+
To install VideoMorph from the source package on your Windows system, first, make sure you have Python3 installed, then run the following steps:
114131

115132
1. Download and decompress the `.zip` source package
116-
117-
3. Open your Windows' command-line (`cmd.exe`), and type the following commands:
133+
2. Open your Windows' command-line (`cmd.exe`), and type the following commands:
118134

119135
```doscon
120136
C:/> cd videomorph-x.x
@@ -123,18 +139,16 @@ C:/> python3 setup.py build
123139
C:/> python3 setup.py install
124140
```
125141

126-
This will install VideoMorph on your system, but you'll need to manually install Ffmpeg.
142+
This will install VideoMorph on your system, but you'll need to install Ffmpeg manually.
127143

128-
**Note:** It's possible that you have to run the second, and the fourth command as an `administrator`.
144+
**Note:** It's possible that you have to run the second and the fourth command as an `administrator`.
129145

130146
### Using Portable Editions (if available)
131147

132-
To use a Portable Edition (PE) of VideoMorph, you just need to:
148+
To use a Portable Edition (PE) of VideoMorph, you need to:
133149

134150
1. Download the PE package that matches your current system
135-
136151
2. Decompress the `.tar.gz` or the `.zip` file (Linux and Windows respectively) in any directory
137-
138152
3. Double-click on VideoMorph's executable (`videomorph` or `videomorph.exe`)
139153

140154
## How to Contribute to the Source
@@ -144,17 +158,11 @@ If you want to contribute to VideoMorph's development cycle, you can follow the
144158
Reach out to contribute with:
145159

146160
- Translations
147-
148161
- Artwork and GUI improvements
149-
150162
- Customized conversion profiles or presets
151-
152163
- Tutorials on how to use VideoMorph
153-
154164
- Documentation
155-
156165
- Feature requests
157-
158166
- Bug reports
159167

160168
Any other type of contributions are also welcome, even a report about a typo is very welcome, so it's your turn to talk, but remember: VideoMorph is just a video converter, not a video editor.
@@ -173,7 +181,7 @@ You also need to install the Ffmpeg library on your system.
173181

174182
### Commits
175183

176-
The members of the VideoMorph Development Team that have the capability to commit changes into the repo are:
184+
The members of the VideoMorph Development Team that can commit changes into the repo are:
177185

178186
- [Leodanis Pozo Ramos](https://github.com/lpozo)
179187
- [Leonel Salazar Videaux](https://github.com/leonel-lordford)
@@ -182,15 +190,10 @@ The members of the VideoMorph Development Team that have the capability to commi
182190
### Internal Contributions Procedure
183191

184192
1. Work on new features, bug fixes, and other changes on a separated local branch
185-
186193
2. Once the work is done, `push` the whole branch to the `videomorph-dev` repo
187-
188194
3. Create a Pull Request (PR) targeting the `develop` branch
189-
190195
4. Wait for review, feedback, and approval
191-
192196
5. Merge the approved PR into the `develop` branch
193-
194197
6. Delete the temporarily branch
195198

196199
**Note:** The preceding procedure is intended to be used by the members of the VideoMorph Development Team.
@@ -200,63 +203,52 @@ The members of the VideoMorph Development Team that have the capability to commi
200203
External contributors must:
201204

202205
- Fork the repo on GitHub
203-
204206
- Work on modifications
205-
206207
- Push modifications to the forked repo
207-
208208
- Make a PR targeting the main VideoMorph `develop` branch
209-
210209
- Wait for review, feedback, and approval
211210

212211
### Branch Naming Conventions
213212

214213
The name for a branch will be like:
215214

216-
`username_i000_topic`
215+
```
216+
username_i000_topic
217+
```
217218

218219
Where:
219220

220221
- `username` corresponds to the GitHub username
221-
222222
- `i000` represents the issue number the branch is dealing with. If there is no issue to map the branch then `i000` will be used
223-
224223
- `topic`, stands for a descriptive name that reflects the main goal of the branch (e.g: `john_i024_feature_mov_format`)
225224

226225
### Coding, and Docstrings Style
227226

228227
- VideoMorph's code will follow the coding style guidelines described in [PEP8](https://www.python.org/dev/peps/pep-0008/)
229-
230228
- Docstrings in VideoMorph's code will follow the guidelines described in [PEP257](https://www.python.org/dev/peps/pep-0257/)
231-
232-
- Tools like `pylint`, `pep8`, `flake`, and other can be used to ensure that coding style guides are met
229+
- Tools like `pylint`, `pep8`, `flake`, and others can be used to ensure that coding style guides are met
233230

234231
### Commit Messaging Style
235232

236233
General rules for writing commit messages:
237234

238235
1. Separate subject from body with a blank line
239-
240236
2. Limit the subject line to 50 characters
241-
242237
3. Capitalize the subject line
243-
244238
4. Do not end the subject line with a period
245-
246239
5. Use the imperative mood in the subject line
247-
248240
6. Wrap the body at 72 characters
241+
7. Use the body to explain what and why vs how
249242

250-
7. Use the body to explain what, and why vs how
243+
```
244+
Add support for MOV format
251245
252-
```
253-
Add support for MOV format
246+
Add support for MOV format with several presets to give more
247+
default conversion options to the user.
248+
```
254249

255-
Add support for MOV format with several presets to give more
256-
default conversion options to the user.
257-
```
250+
Keep in mind that not all commits require an explanatory body, sometimes with the subject line is enough.
258251

259-
Keep in mind that not all commits require a explanatory body, sometimes with the subject line is enough.
260252
For more details see: [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/)
261253

262254
## Licensing
@@ -269,15 +261,15 @@ Following the idea of [python-video-converter](https://github.com/senko/python-v
269261

270262
Authors:
271263

272-
- [Leodanis Pozo Ramos](mailto:[email protected])
273-
- [Ozkar L. Garcell](mailto:[email protected])
264+
- [Leodanis Pozo Ramos](mailto:[email protected])
265+
- [Ozkar L. Garcell](mailto:[email protected])
274266

275267
Contributors:
276268

277-
- [Maikel Llamaret Heredia](http://gutl.jovenclub.cu) **[Rest In Peace Dear Friend]**
278-
- [Leonel Salazar Videaux](http://debianhlg.cubava.cu/)
279-
- [Carlos Parra Zaldivar](http://libreoffice.cubava.cu)
280-
- Osmel Cruz
269+
- [Maikel Llamaret Heredia](http://gutl.jovenclub.cu) **[Rest In Peace Dear Friend]**
270+
- [Leonel Salazar Videaux](http://debianhlg.cubava.cu/)
271+
- [Carlos Parra Zaldivar](http://libreoffice.cubava.cu)
272+
- Osmel Cruz
281273

282274
## Copyright
283275

0 commit comments

Comments
 (0)