Skip to content

Commit 87883ad

Browse files
committed
Convert README and ChangeLog to markdown
1 parent 0b1ef55 commit 87883ad

File tree

5 files changed

+105
-109
lines changed

5 files changed

+105
-109
lines changed

ChangeLog.adoc

Lines changed: 0 additions & 76 deletions
This file was deleted.

ChangeLog.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# gitchart ChangeLog
2+
3+
## Version 1.6 (under dev)
4+
5+
- Convert README and ChangeLog to markdown.
6+
7+
## Version 1.5 (2020-03-07)
8+
9+
- Switch from Travis CI to GitHub actions.
10+
- Add file requirements.txt.
11+
12+
## Version 1.4 (2019-07-13)
13+
14+
- Add chart `tickets_author`.
15+
- Add option `-m` / `--no-merges` to not count merge commits in git log commands.
16+
- Add setup.py.
17+
18+
## Version 1.3 (2016-08-13)
19+
20+
- Fix check of javascript command line argument (issue #3).
21+
- Add argument `--all` for git log commands.
22+
23+
## Version 1.2 (2014-12-06)
24+
25+
- Add option `-j` / `--js` to customize javascript files/links.
26+
- Fix the working directory for the second git command.
27+
28+
## Version 1.1 (2014-04-18)
29+
30+
- Fix PEP8 warnings.
31+
32+
## Version 1.0 (2013-11-10)
33+
34+
- Fix parsing of authors.
35+
36+
## Version 0.9 (2013-11-10)
37+
38+
- Ignore UTF-8 decoding errors.
39+
40+
## Version 0.8 (2013-11-10)
41+
42+
- Add chart "commits_day".
43+
- Rename chart `commits_hour` to `commits_hour_day` and `commits_day` to `commits_day_week`.
44+
- Add option `-s` / `--sort-max`.
45+
- Rename option `-m` / `--max` to `-d` / `--max-diff`.
46+
47+
## Version 0.7 (2013-11-09)
48+
49+
- Fix chart title.
50+
51+
## Version 0.6 (2013-11-08)
52+
53+
- Add a main function.
54+
55+
## Version 0.5 (2013-11-02)
56+
57+
- Make options title/repository optional.
58+
- Add option `-m` / `--max`.
59+
- Display SVG on standard output if filename is "-".
60+
61+
## Version 0.4 (2013-10-25)
62+
63+
- Add PNG support.
64+
65+
## Version 0.3 (2013-03-21)
66+
67+
- Fill months without commits (set value to 0) in chart `commits_year_month`.
68+
69+
## Version 0.2 (2013-03-16)
70+
71+
- Read all data on standard input (no more limit at 1MB).
72+
- Add missing argument `title` in help.
73+
74+
## Version 0.1 (2013-03-15)
75+
76+
- First release.

README.adoc renamed to README.md

Lines changed: 27 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,72 @@
1-
= gitchart
2-
:author: Sébastien Helleu
3-
4-
:lang: en
1+
# gitchart
52

6-
image:https://img.shields.io/pypi/v/gitchart.svg["PyPI", link="https://pypi.org/project/gitchart/"]
7-
image:https://github.com/flashcode/gitchart/workflows/CI/badge.svg["CI", link="https://github.com/flashcode/gitchart/actions"]
3+
[![PyPI](https://img.shields.io/pypi/v/gitchart.svg)](https://pypi.org/project/gitchart/)
4+
[![Build Status](https://github.com/flashcode/gitchart/workflows/CI/badge.svg)](https://github.com/flashcode/gitchart/actions?query=workflow%3A%22CI%22)
85

96
Gitchart is a Python script to build charts from a Git repository.
107

118
It can build following charts, as SVG or PNG:
129

13-
* authors, processed tickets by author (pie charts)
14-
* commits by hour of day, day, day of week, month of year, year, year/month
15-
(bar charts)
16-
* commits by hour of week (dot chart)
17-
* files by type (pie chart)
10+
- authors, processed tickets by author (pie charts)
11+
- commits by hour of day, day, day of week, month of year, year, year/month (bar charts)
12+
- commits by hour of week (dot chart)
13+
- files by type (pie chart)
1814

19-
== Requirements
15+
## Requirements
2016

2117
Gitchart requires:
2218

23-
* Python >= 2.7
24-
* http://pygal.org/[Pygal] (`pip install pygal`)
19+
- Python 2.7
20+
- http://pygal.org/[Pygal] (`pip install pygal`)
2521

2622
Optional dependencies:
2723

28-
* cairosvg, to generate PNG files
24+
- cairosvg, to generate PNG files
2925

30-
== Install
26+
## Install
3127

3228
You can install gitchart with this command from the source repository:
3329

34-
----
30+
```
3531
$ python setup.py install
36-
----
32+
```
3733

38-
== Usage
34+
## Usage
3935

4036
See output of command:
4137

42-
----
38+
```
4339
$ gitchart -h
44-
----
40+
```
4541

46-
== Examples
42+
## Examples
4743

4844
Generate pie chart with authors:
4945

50-
----
46+
```
5147
$ gitchart -t "Git authors on project X" -r /path/to/gitrepo/ authors authors.svg
52-
----
48+
```
5349

5450
Generate bar chart with commits by year:
5551

56-
----
52+
```
5753
$ gitchart -r /path/to/gitrepo/ commits_year commits_year.svg
58-
----
54+
```
5955

6056
Generate bar chart with commits by version (git tag):
6157

62-
----
58+
```
6359
$ cd /path/to/gitrepo/
6460
$ git tag | gitchart commits_version /tmp/commits_version.svg
65-
----
61+
```
6662

67-
== Demo
63+
## Demo
6864

6965
Gitchart is used to build statistics for WeeChat: https://weechat.org/dev/stats/
7066

71-
== Copyright
67+
## Copyright
7268

73-
Copyright (C) 2013-2020 Sébastien Helleu <[email protected]>
69+
Copyright © 2013-2020 [Sébastien Helleu](https://github.com/flashcode)
7470

7571
This program is free software; you can redistribute it and/or modify
7672
it under the terms of the GNU General Public License as published by

gitchart.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151

5252
import pygal
5353

54-
VERSION = '1.5'
54+
VERSION = '1.6-dev'
5555

5656
ISSUES_REGEX_DEFAULT = re.compile(
5757
r'(?:close|closes|closed|fix|fixes|fixed|resolve|resolves|resolved)'

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939

4040
setup(
4141
name='gitchart',
42-
version='1.5',
42+
version='1.6-dev',
4343
description=DESCRIPTION,
4444
long_description=LONG_DESCRIPTION,
4545
author='Sébastien Helleu',

0 commit comments

Comments
 (0)