summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md62
1 files changed, 62 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000000..af0bf084f40
--- /dev/null
+++ b/README.md
@@ -0,0 +1,62 @@
+pkgsrc
+======
+
+[pkgsrc](https://pkgsrc.org) is a framework for building software for a
+variety of UNIX-like systems.
+
+It produces binary packages, which can be managed with tools such as
+[pkgin](http://pkgin.net/).
+
+Bootstrapping
+-------------
+
+To use pkgsrc on operating systems other than NetBSD, you first need to
+bootstrap:
+
+ cd pkgsrc/bootstrap
+ ./bootstrap
+
+Note that this is only for the most simple case, using pkgsrc's defaults.
+Please consult `bootstrap/README` and `bootstrap/README.OS` for detailed
+information about bootstrapping.
+
+Building packages
+-----------------
+
+ cd pkgsrc/category/package-name
+ $PREFIX/bin/bmake install
+
+Where `$PREFIX` is where you've chosen to install packages (typically`/usr/pkg`)
+
+On NetBSD, `bmake` is simply the built-in `make` tool.
+
+To build packages in bulk, tools such as `pkgtools/pbulk` and
+`pkgtools/pkg_comp` can be used.
+
+Troubleshooting
+---------------
+
+- Join the community IRC channel [#pkgsrc @ freenode](https://webchat.freenode.net/?channels=#pkgsrc).
+- Subscribe to the [pkgsrc-users](https://netbsd.org/mailinglists/#pkgsrc-users) mailing list
+- Send bugs and patches [via web form](https://www.netbsd.org/cgi-bin/sendpr.cgi?gndb=netbsd) (use the `pkg` category).
+
+Latest sources
+--------------
+
+To fetch the main CVS repository:
+
+ cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc
+
+To work in the Git mirror, which is updated every few hours from CVS:
+
+ git clone https://github.com/NetBSD/pkgsrc.git
+
+Additional links
+----------------
+
+- [The pkgsrc guide](https://www.netbsd.org/docs/pkgsrc/)
+- [pkgsrc in the NetBSD Wiki](https://wiki.netbsd.org/pkgsrc/)
+- [pkgsrc.se](http://pkgsrc.se/) - a browsable index for pkgsrc packages
+- [pkgsrc-wip](https://pkgsrc.org/wip/) - a project to get more people actively involved with creating packages for pkgsrc
+- [pkgsrc on Twitter](https://twitter.com/pkgsrc)
+- [pkgsrcCon](https://pkgsrc.org/pkgsrcCon)