aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorYuchen Pei <id@ypei.org>2023-06-26 17:28:40 +1000
committerYuchen Pei <id@ypei.org>2023-06-26 17:28:40 +1000
commita52cc6222a66242e62cc0869aa77b099b2b038b5 (patch)
tree29a24ce2165206f60e7a14091b8c2c5765dbd4b2 /README.org
parent07c135a7ce5769dd2cf3076eab790d2514fef97d (diff)
Prepare for elpa
* .gitignore: Adding elc * README.org: minor changes to intro and todos * buildbot-client.el: minor formatting and documentation fix * buildbot-utils.el: minor formatting fix * buildbot-view.el: minor formatting and require fix * buildbot.el: minor keywords and formatting fix
Diffstat (limited to 'README.org')
-rw-r--r--README.org21
1 files changed, 17 insertions, 4 deletions
diff --git a/README.org b/README.org
index f844881..81c0fce 100644
--- a/README.org
+++ b/README.org
@@ -1,11 +1,19 @@
#+title: buildbot.el
+#+author: Yuchen Pei
+#+language: en
-buildbot.el is a buildbot client for emacs. It shows views for
-branches, revisions, builds, steps, and logs.
+[[https://www.buildbot.net/][Buildbot]] is a free software continuous integration tool. buildbot.el
+is an emacs interface to view build information on a Buildbot
+instance. It supports newer versions of Buildbot (e.g. 3.x) but not
+older versions (e.g. 0.8.9) and shows views for branches, revisions,
+builds, steps, logs and builders.
* Install
** Manual install
+ :PROPERTIES:
+ :UPDATED: [2023-06-26 Mon 16:44]
+ :END:
Clone this repo, and add to load path (assuming you clone to
~~/.emacs.d~):
@@ -19,7 +27,7 @@ git clone https://g.ypei.me/buildbot.el.git
(add-to-list 'load-path "~/.emacs.d/buildbot.el")
#+end_src
-After that, require buildbot and set the host and builders.
+After that, require buildbot and set the host and builders, like so
#+begin_src elisp
(require 'buildbot)
@@ -40,9 +48,14 @@ Entry points:
builder.
* TODOs
+ :PROPERTIES:
+ :UPDATED: [2023-06-26 Mon 17:04]
+ :END:
- org link integration.
-- older buildbot api.
+- older buildbot api (not really sure if feasible)
+- copy url of the current view
+- highlight certain builders (e.g. mandatory for push)
* Contact and Copyright