Add a Gentoo package section to the README.
authorW. Trevor King <wking@drexel.edu>
Tue, 2 Nov 2010 21:14:27 +0000 (17:14 -0400)
committerW. Trevor King <wking@drexel.edu>
Tue, 2 Nov 2010 21:14:27 +0000 (17:14 -0400)
README

diff --git a/README b/README
index 12f94540e77789d54c5e676aca3f944b95e032e7..a44781cf4241bb7c2e27de889788c73a673c1866 100644 (file)
--- a/README
+++ b/README
@@ -1,3 +1,31 @@
+Sawsim is a force-spectroscopy simulator.  See the manual for more
+details.
+
+
+Packages
+--------
+
+Gentoo
+~~~~~~
+
+I've packaged sawsim for Gentoo_ as sci-physics/sawsim in my `wtk
+overlay`_.  To install, add my overlay to your Layman_ config file,
+and run::
+
+  # emerge -av sci-physics/sawsim
+
+To stay current, follow the sawsim `Atom`_ or `RSS`_ feed, and
+re-emerge when there are interesting changes.
+
+You can skip the Compiling_ and Upgrading_ sections of this README ;).
+
+.. _Gentoo: http://www.gentoo.org/
+.. _wtk overlay: http://www.physics.drexel.edu/~wking/unfolding-disasters/posts/Gentoo_overlay/
+.. _Layman: http://www.gentoo.org/proj/en/overlays/userguide.xml
+.. _Atom: http://www.physics.drexel.edu/~wking/code/git/gitweb.cgi?p=sawsim.git;a=atom
+.. _RSS: http://www.physics.drexel.edu/~wking/code/git/gitweb.cgi?p=sawsim.git;a=rss
+
+
 Compiling
 ---------