summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Kost <alezost@gmail.com>2018-08-30 18:02:01 +0300
committerAlex Kost <alezost@gmail.com>2018-08-30 18:02:01 +0300
commit82dbf78aa5897616be9dc62fdef089dc758a5d86 (patch)
treed5ef6405d9afe5f305dee00f3b1f2872260ee3b9
parentpopup: Switch keys for jobset and job (diff)
downloademacs-build-farm-82dbf78aa5897616be9dc62fdef089dc758a5d86.tar.gz
README: Add "Installation" section and some badges
-rw-r--r--README.org27
1 files changed, 25 insertions, 2 deletions
diff --git a/README.org b/README.org
index a7a85d2..232e99f 100644
--- a/README.org
+++ b/README.org
@@ -1,3 +1,7 @@
+[[file:https://img.shields.io/badge/license-GPL_3-orange.svg]]
+[[http://melpa.org/#/build-farm][file:http://melpa.org/packages/build-farm-badge.svg]]
+[[http://stable.melpa.org/#/build-farm][file:http://stable.melpa.org/packages/build-farm-badge.svg]]
+
* About
=Emacs-Build-Farm= is an Emacs interface for [[https://nixos.org/hydra/][Hydra]] and [[https://git.savannah.gnu.org/cgit/guix/guix-cuirass.git/][Cuirass]] — build
@@ -10,11 +14,30 @@ farms for [[https://nixos.org/nix/][Nix]] and [[https://www.gnu.org/software/gui
This package allows you to look at builds, jobsets, evaluations and
projects of these build farms.
+* Installation
+
+Emacs-Build-Farm can be installed using Guix or from [[https://melpa.org/][MELPA]].
+
+** Guix
+
+Just use:
+
+#+BEGIN_SRC sh
+guix package -i emacs-build-farm
+#+END_SRC
+
+** MELPA
+
+If you added "melpa" or "melpa-stable" archives to =package-archives= as
+it is described on the [[https://melpa.org/#/getting-started][MELPA Getting Started]] page, you can install
+"emacs-build-farm" using =M-x package-install= or =M-x list-packages=
+commands.
+
* Usage
The entry point for the available features is =M-x build-farm= command.
-It provides a [[https://github.com/magit/magit-popup][magit-popup]] interface to display builds, jobsets and
-projects.
+It provides a [[https://github.com/magit/magit-popup][magit-popup]] interface to display evaluations, builds,
+jobsets and projects.
Alternatively, you can use the following =M-x= commands directly: