summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authormaya <maya@pkgsrc.org>2017-03-02 09:51:35 +0000
committermaya <maya@pkgsrc.org>2017-03-02 09:51:35 +0000
commit5c80368663bf4030bbbf5968d471c74c80552e04 (patch)
tree186fb3030fb4e0b2de61063a9dc5d0711a98dc4d /README
parentcb06af01760fdb53a1822416beb14a94e75678f9 (diff)
downloadpkgsrc-5c80368663bf4030bbbf5968d471c74c80552e04.tar.gz
Make top dir README a little more helpful.
This file is very prominent on github, so use this opportunity to give a quick intro to pkgsrc. mention main repo location so it's obvious even when using a fork & bug report address.
Diffstat (limited to 'README')
-rw-r--r--README23
1 files changed, 22 insertions, 1 deletions
diff --git a/README b/README
index 881848b74c8..ec5c596c56b 100644
--- a/README
+++ b/README
@@ -1,3 +1,24 @@
-$NetBSD: README,v 1.18 2005/05/07 22:18:28 wiz Exp $
+$NetBSD: README,v 1.19 2017/03/02 09:51:35 maya Exp $
+
+pkgsrc is a framework for building software on UNIX-like systems.
+
+To use, bootstrap using:
+% cd pkgsrc/bootstrap/
+% ./bootstrap
+
+build packages, use:
+% cd pkgsrc/category/package-name
+% $PREFIX/bin/bmake install
+
+Where $PREFIX is where you've chosen to install packages (typically /usr/pkg)
+
+Bugs and patches can be filed in the follow link (use category 'pkg'):
+https://www.netbsd.org/cgi-bin/sendpr.cgi?gndb=netbsd
+
+To fetch the main CVS repository:
+% cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc
+
+It's also possible to contribute through pkgsrc wip (work in progress), for
+more information, see http://pkgsrc.org/wip/users/
Please see doc/pkgsrc.txt for information.