aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'src/lintool/README')
-rw-r--r--src/lintool/README23
1 files changed, 23 insertions, 0 deletions
diff --git a/src/lintool/README b/src/lintool/README
new file mode 100644
index 0000000..1494aad
--- /dev/null
+++ b/src/lintool/README
@@ -0,0 +1,23 @@
+
+Package: Lintool
+Version: 0.1.3
+Author : Karl Trygve Kalleberg <karltk@gentoo.org>
+
+
+MOTIVATION
+
+Lintool is a "lint" utility for the Gentoo Linux distribution. It is a
+tool that tests ebuilds, changelogs and package digests for
+well-formedness. It's intended to aid Gentoo Linux developers avoid most
+common mistakes when packaging software for Gentoo.
+
+MECHANICS
+
+To check an ebuild, do lintool --ebuild <path-to-ebuild>
+To check a ChangeLog, do lintool --changelog <path-to-changelog>
+To check a package digest, do lintoo --digest <path-to-digest>
+
+IMPROVEMENTS
+
+Any suggestions for improvements should be sent to karltk@gentoo.org, or
+added as a bug assigned to me.