Skip to content

Commit a68cd2c

Browse files
committed
change readme format
1 parent 09404ee commit a68cd2c

File tree

5 files changed

+35
-30
lines changed

5 files changed

+35
-30
lines changed

Diff for: .gitignore

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
/env
22
/build
33
/dist
4-
/README.rst
54
/docsrc/_build
65
/docsrc/source
76
/*.egg-info

Diff for: MANIFEST.in

-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
include README.md
21
include LICENSE
32
include demo.py
43
include docsrc/Makefile

Diff for: README.md

-26
This file was deleted.

Diff for: README.rst

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
pygtkdrawingwindow
2+
==================
3+
4+
Requirements
5+
------------
6+
7+
- `pygtk <http://www.pygtk.org/>`__ or
8+
`gir1.2-gtk-3.0 <https://lazka.github.io/pgi-docs/Gtk-3.0/index.html>`__
9+
- `pycairo <https://cairographics.org/pycairo/>`__
10+
11+
Optional
12+
~~~~~~~~
13+
14+
- `python-rsvg <http://ftp.gnome.org/pub/GNOME/sources/gnome-python-desktop/>`__
15+
or
16+
`gir1.2-rsvg-2.0 <https://lazka.github.io/pgi-docs/Rsvg-2.0/index.html>`__
17+
18+
Installation
19+
------------
20+
21+
.. code:: bash
22+
23+
python setup.py install
24+
25+
.. code:: bash
26+
27+
git clone https://github.com/dead-beef/pygtkdrawingwindow
28+
cd pygtkdrawingwindow
29+
pip install -e .[dev]
30+
31+
Licenses
32+
--------
33+
34+
- `pygtkdrawingwindow <LICENSE>`__
35+

Diff for: build.sh

-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
#!/bin/sh
22

33
rm -rfv build/* dist/* docs/* docsrc/source/* \
4-
&& (sed -r 's/`([^`]+)`/\1/g' README.md \
5-
| pandoc -f markdown_github -t rst >README.rst) \
64
&& make -C docsrc apidoc html \
75
&& python setup.py sdist bdist_wheel

0 commit comments

Comments
 (0)