Skip to content

Commit dcf46cd

Browse files
author
FND
committed
added README
thus renamed auto-generated long-description file from README to DESC GitHub demands a README file to be part of the repo, so we're using an abridged version of the doctring. This means there's some duplication (risking documentation rot) after all, but that can't be helped.
1 parent 9874f8a commit dcf46cd

File tree

4 files changed

+15
-3
lines changed

4 files changed

+15
-3
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
*.pyc
2-
README
2+
DESC

Makefile

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ test:
44
py.test -x test
55

66
dist: clean test
7-
python -c 'import spackager; print spackager.__doc__.strip()' > README
7+
python -c 'import spackager; print spackager.__doc__.strip()' > DESC
88
python setup.py sdist
99

1010
release: dist pypi
@@ -17,3 +17,4 @@ clean:
1717
rm -r dist || true
1818
rm -r build || true
1919
rm -r *.egg-info || true
20+
rm DESC || true

README

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Spackager
2+
single-page app compiler
3+
4+
parses an HTML file for external resources (JavaScript, CSS and image files) and
5+
assembles them into a stand-alone document
6+
7+
http://github.com/FND/spackager
8+
http://pypi.python.org/pypi/spackager
9+
10+
Usage:
11+
pydoc spackager

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
name = NAME,
1616
version = __version__,
1717
description = DESCRIPTION,
18-
long_description = open(os.path.join(os.path.dirname(__file__), 'README')).read(),
18+
long_description = open(os.path.join(os.path.dirname(__file__), 'DESC')).read(),
1919
author = AUTHOR,
2020
author_email = AUTHOR_EMAIL,
2121
url = 'http://pypi.python.org/pypi/%s' % NAME,

0 commit comments

Comments
 (0)