summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7647a2d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# Experimental Grid Engine mode
+
+
+## Setup
+
+```elisp
+(add-to-list 'load-path "/path/to/grid-engine-mode/")
+(require 'grid-engine-mode)
+
+(setq grid-engine-host "login.cluster.node")
+
+;; display jobs for all users
+(setq grid-engine-user "'*'")
+```
+
+Then run `M-x grid-engine-list-jobs` to view jobs.
+
+
+## Features
+
+Hardly any. List jobs with `grid-engine-list-jobs` and view details
+by hitting RET on any job in the list.