From 81a50a26e4e63827fc43cec816661af368df57dd Mon Sep 17 00:00:00 2001 From: max furman Date: Thu, 11 Apr 2019 16:02:13 -0700 Subject: [PATCH] docs: added archlinux install and distribution info --- README.md | 14 +++++++++++++- docs/distribution.md | 35 +++++++++++++++++++++++++---------- 2 files changed, 38 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index f952774a..a460efdc 100644 --- a/README.md +++ b/README.md @@ -99,6 +99,8 @@ $ brew uninstall step ### Linux +#### Debian + 1. [Optional] Install `step cli`. Download the latest Debian package from @@ -129,7 +131,17 @@ $ brew uninstall step $ sudo dpkg -i step-certificates_X.Y.Z_amd64.deb ``` -3. Test. +#### Arch Linux + +We are using the [Arch User Repository](https://aur.archlinux.org) to distribute +`step` binaries for Arch Linux. + +* [Optional] The `step-cli` binary tarball can be found [here](https://aur.archlinux.org/packages/step-cli-bin/). +* The `step-ca` binary tarball can be found [here](https://aur.archlinux.org/packages/step-ca-bin/). + +You can use [pacman](https://www.archlinux.org/pacman/) to install the packages. + +### Test

     $ step version
diff --git a/docs/distribution.md b/docs/distribution.md
index 3bdef552..7e3907b9 100644
--- a/docs/distribution.md
+++ b/docs/distribution.md
@@ -27,8 +27,8 @@ e.g. `v1.0.2`
     that all local changes have been pushed.
 
     ```
-    git pull --rebase origin master
-    git push
+    $ git pull --rebase origin master
+    $ git push
     ```
 
 3. **Tag it!**
@@ -36,8 +36,8 @@ e.g. `v1.0.2`
     1. **Find the most recent tag.**
 
         ```
-        git fetch --tags
-        git tag
+        $ git fetch --tags
+        $ git tag
         ```
 
         The new tag needs to be the logical successor of the most recent existing tag.
@@ -65,17 +65,17 @@ e.g. `v1.0.2`
     3. **Create a local tag.**
 
         ```
-        git tag v1.0.3   # standard release
+        $ git tag v1.0.3   # standard release
         ...or
-        git tag v1.0.3-rc.1  # release candidate
+        $ git tag v1.0.3-rc.1  # release candidate
         ```
 
     4. **Push the new tag to the remote origin.**
 
         ```
-        git push origin tag v1.0.3   # standard release
+        $ git push origin tag v1.0.3   # standard release
         ...or
-        git push origin tag v1.0.3-rc.1  # release candidate
+        $ git push origin tag v1.0.3-rc.1  # release candidate
         ```
 
 4. Check the build status at
@@ -93,9 +93,24 @@ e.g. `v1.0.2`
     * **step-certificates_1.0.3_darwin_amd64.tar.gz**: tarball containing a statically compiled darwin binary.
     * **step-certificates.tar.gz**: tarball containing a git archive of the full repo.
 
+6. **Update the AUR Arch Linux package**
+
+    **NOTE**: if you plan to release `cli` next then you can skip this step.
+
+    ```
+    $ cd archlinux
+
+    # Get up to date...
+    $ git pull origin master
+    $ make
+
+    $ ./update --ca v1.0.3
+    ```
+
 *All Done!*
 
 ## Versioning
 
-We use [SemVer](http://semver.org/) for versioning. For the versions available,
-see the [tags on this repository](https://github.com/smallstep/certificates).
+We use [SemVer](http://semver.org/) for versioning. See the
+[tags on this repository](https://github.com/smallstep/certificates) for all
+available versions.