Skip to content

Commit d9b07cd

Browse files
committed
[#66] Updated README.md format.
1 parent 6ae33f0 commit d9b07cd

1 file changed

Lines changed: 26 additions & 24 deletions

File tree

README.md

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
About
22
-----
33

4-
Python module for manipulating SMPTE timecode. Supports all formats in the ST12 standard,
5-
as well as any arbitrary integer frame rates and some default str values of 23.976, 23.98,
6-
24, 25, 29.97, 30, 50, 59.94, 60 frame rates and milliseconds (1000 fps) and fractional
7-
frame rates like "30000/1001".
4+
Python module for manipulating SMPTE timecode. Supports all formats in the ST12
5+
standard, as well as any arbitrary integer frame rates and some default str
6+
values of 23.976, 23.98, 24, 25, 29.97, 30, 50, 59.94, 60 frame rates and
7+
milliseconds (1000 fps) and fractional frame rates like "30000/1001".
88

9-
This library is a fork of the original PyTimeCode python library. You should not use
10-
the two library together (PyTimeCode is not maintained and has known bugs).
9+
This library is a fork of the original PyTimeCode python library. You should
10+
not use the two library together (PyTimeCode is not maintained and has known
11+
bugs).
1112

1213
The math behind the drop frame calculation is based on the
1314
[blog post of David Heidelberger](http://www.davidheidelberger.com/blog/?p=29).
1415

15-
Simple math operations like, addition, subtraction, multiplication or division with an
16-
integer value or with a timecode is possible. Math operations between timecodes with
17-
different frame rates are supported. So:
16+
Simple math operations like, addition, subtraction, multiplication or division
17+
with an integer value or with a timecode is possible. Math operations between
18+
timecodes with different frame rates are supported. So:
1819

1920
```py
2021
from timecode import Timecode
@@ -27,8 +28,8 @@ assert tc3.frames == 12
2728
assert tc3 == '00:00:00:11'
2829
```
2930

30-
Creating a Timecode instance with a start timecode of '00:00:00:00' will result a
31-
timecode object where the total number of frames is 1. So:
31+
Creating a Timecode instance with a start timecode of '00:00:00:00' will result
32+
a timecode object where the total number of frames is 1. So:
3233

3334
```py
3435
tc4 = Timecode('24', '00:00:00:00')
@@ -42,14 +43,14 @@ assert tc4.frame_number == 0
4243
```
4344

4445
> [!NOTE]
45-
> A common misconception is that `00:00:00:00` should have 0 frames. This is wrong
46-
> because Timecode is a label given for each frame in a media, and it happens to be
47-
> using numbers which are seemingly incremented one after another. So, for a Timecode to
48-
> exist there should be a frame. and 00:00:00:00 is generally the label given to the
49-
> first frame.
46+
> A common misconception is that `00:00:00:00` should have 0 frames. This is
47+
> wrong because Timecode is a label given for each frame in a media, and it
48+
> happens to be using numbers which are seemingly incremented one after
49+
> another. So, for a Timecode to exist there should be a frame. and 00:00:00:00
50+
> is generally the label given to the first frame.
5051
51-
Frame rates 29.97, 59.94 and 119.88 are always drop frame, and all the others are non drop
52-
frame.
52+
Frame rates 29.97, 59.94 and 119.88 are always drop frame, and all the others
53+
are non drop frame.
5354

5455
The timecode library supports fractional frame rates passed as a string:
5556

@@ -68,8 +69,8 @@ assert repr(tc6) == '19:23:14:23'
6869
This is useful for parsing timecodes stored in OpenEXR's and extracted through
6970
OpenImageIO for instance.
7071

71-
Timecode also supports passing start timecodes formatted like HH:MM:SS.sss where SS.sss
72-
is seconds and fractions of seconds:
72+
Timecode also supports passing start timecodes formatted like HH:MM:SS.sss
73+
where SS.sss is seconds and fractions of seconds:
7374

7475
```py
7576
tc8 = Timecode(25, '00:00:00.040')
@@ -88,10 +89,11 @@ assert repr(tc9) == '19:23:14.958'
8889

8990
Fraction of seconds is useful when working with tools like FFmpeg.
9091

91-
The SMPTE standard limits the timecode with 24 hours. Even though, Timecode instance
92-
will show the current timecode inline with the SMPTE standard, it will keep counting the
93-
total frames without clipping it.
92+
The SMPTE standard limits the timecode with 24 hours. Even though, Timecode
93+
instance will show the current timecode inline with the SMPTE standard, it will
94+
keep counting the total frames without clipping it.
9495

95-
Please report any bugs to the [GitHub](https://github.com/eoyilmaz/timecode) page.
96+
Please report any bugs to the [GitHub](https://github.com/eoyilmaz/timecode)
97+
page.
9698

9799
Copyright 2014 Joshua Banton and PyTimeCode developers.

0 commit comments

Comments
 (0)