summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Friesel <derf@derf.homelinux.org>2009-05-17 14:54:36 +0200
committerDaniel Friesel <derf@derf.homelinux.org>2009-05-17 14:54:36 +0200
commit559ed7359bcda4ca8debb9373654b4c7fd232c99 (patch)
tree3646508db48d7b82c55563392564f1352f80f68f
parent88b535769e24fc0205d50d6fd1975134050e7503 (diff)
Added a little pkg-setup document
-rw-r--r--README2
-rw-r--r--man/7/pkg-setup23
2 files changed, 25 insertions, 0 deletions
diff --git a/README b/README
index 3fd9c63..89ffe44 100644
--- a/README
+++ b/README
@@ -1,5 +1,7 @@
pkg - distributed dotfile and script manager
+For setup: perldoc man/7/pkg-setup
+
Requires:
- zsh
- git
diff --git a/man/7/pkg-setup b/man/7/pkg-setup
new file mode 100644
index 0000000..2efd7d3
--- /dev/null
+++ b/man/7/pkg-setup
@@ -0,0 +1,23 @@
+=pod
+
+=head1 NAME
+
+pkg - Package root setup
+
+=head1 PACKAGE ROOT
+
+First, you'll need to create a root directory (from now on PKG_ROOT) on the
+server which shall from now on host all your packages.
+Then you need to put the pkg git repository into F<PKG_ROOT/core> - it's recommended
+to do this via git clone --bare.
+
+Copy the pkglist script (include/pkglist) to F<PKG_ROOT/pkglist>.
+
+Now you can add your own packages as git repos in PKG_ROOT.
+
+To use pkg with your packages on a machine, download and execute
+the bootstrap script (include/bootstrap).
+
+=cut
+
+vim:ft=pod