From d26449224b7d0329964f571f20e8b74f7ce6c0e2 Mon Sep 17 00:00:00 2001 From: Lars Butler Date: Thu, 3 Apr 2014 11:08:29 +0200 Subject: [PATCH 1/3] README.md: use GitHub markdown header style --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 701991f..e51479c 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,9 @@ -zpm -=== +# zpm ZeroVM Package Manager -Packaging ---------- +## Packaging 1. Install debian packaging dependencies: From f0e2cddae7f03a69228646fc2ea546d8af3740bd Mon Sep 17 00:00:00 2001 From: Lars Butler Date: Thu, 3 Apr 2014 11:15:21 +0200 Subject: [PATCH 2/3] README.md: add installation instruction section Installation instructions were missing from the README, and this seemed to be causing confusion for the users (who though they had to package `zpm` in order to install and use it). --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index e51479c..d22ef1a 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,25 @@ ZeroVM Package Manager +## Installation + +There are currently two options for installing `zpm`. + +- Clone and install: + + ```bash + $ git clone https://github.com/zerovm/zpm.git + $ cd zpm + $ python setup.py install + ``` + +- Install directly from `git` using `pip`: + + ```bash + $ pip install git+https://github.com/zerovm/zpm.git + ``` + + ## Packaging 1. Install debian packaging dependencies: From b10d18d1e90667c6e74fdbfc6b39a4fec53bc0e4 Mon Sep 17 00:00:00 2001 From: Lars Butler Date: Thu, 3 Apr 2014 11:16:15 +0200 Subject: [PATCH 3/3] README.md: add a usage note to `Packaging` Packaging is only interesting to maintainers and packagers, not end users. So I think it's a good idea to put a small warning/note at the top of the packaging section to keep users from falling down rabbit holes. --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index d22ef1a..e23d68b 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,9 @@ There are currently two options for installing `zpm`. ## Packaging +Note: This section is interesting only for project maintainers and packagers. +This is not required for installing and using `zpm`. + 1. Install debian packaging dependencies: $ sudo apt-get install devscripts debhelper