initial commit

1 files changed, 28 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..262e58b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# asp
+
+`asp` is a tool to manage the build source files used to create Arch Linux
+packages. It attempts to replace the `abs` tool, offering more up to date
+sources (via the svntogit repositories) and uses a sparse checkout model to
+conserve diskspace. This probably won't be interesting to users who want a
+full checkout (for whatever reason that may be).
+
+# Setup
+
+None! Though, it should be noted that the **ASPROOT** environment variable
+will control where `asp` keeps its locally tracked packages. By default, this
+is `$HOME/asp`.
+
+# Examples
+
+Get the source files for some packages:
+
+~~~
+asp export pacman testing/systemd extra/pkgfile
+~~~
+
+List the repositories a package has been pushed to:
+
+~~~
+asp list-repos pacman
+~~~
+