diff options
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 28 |
1 files changed, 25 insertions, 3 deletions
diff --git a/README.org b/README.org index 423dfc21ae87..3138eeb8a791 100644 --- a/README.org +++ b/README.org @@ -1,8 +1,12 @@ #+TITLE: Org-Clubhouse -Simple, unopinionated integration between Emacs's [[https://orgmode.org/][org-mode]] and the [[https://clubhouse.io/][Clubhouse]] issue tracker +Simple, unopinionated integration between Emacs's [[https://orgmode.org/][org-mode]] and the [[https://clubhouse.io/][Clubhouse]] +issue tracker -* Install +(This used to be at urbint/org-clubhouse, by the way, but moved here as it's +more of a personal project than a company one) + +* Installation ** [[https://github.com/quelpa/quelpa][Quelpa]] @@ -32,6 +36,7 @@ Simple, unopinionated integration between Emacs's [[https://orgmode.org/][org-mo '((org-clubhouse :location (recipe :fetcher github :repo "urbint/org-clubhouse"))) #+END_SRC + * Setup Once installed, you'll need to set three global config vars: @@ -84,7 +89,24 @@ org-clubhouse provides the following commands: Adds the user configured in ~org-clubhouse-username~ as the owner of the clubhouse story associated with the headline at point +* Philosophy + +I use org-mode every single day to manage tasks, notes, literate programming, +etc. Part of what that means for me is that I already have a system for the +structure of my .org files, and I don't want to sacrifice that system for any +external tool. Updating statuses, ~org-clubhouse-create-story~, and +~org-clubhouse-headline-from-story~ are my bread and butter for that reason - +rather than having some sort of bidirectional sync that pulls down full lists of +all the stories in Clubhouse (or whatever issue tracker / project management +tool I'm using at the time). I can be in a mode where I'm taking meeting notes, +think of something that I need to do, make it a TODO headline, and make that +TODO headline a clubhouse story. That's the same reason for the DESCRIPTION +drawers rather than just sending the entire contents of a headline to +Clubhouse - I almost always want to write things like personal notes, literate +code, etc inside of the tasks I'm working on, and don't always want to share +that with Clubhouse. + * Configuration -Refer to the beginning of the [[https://github.com/urbint/org-clubhouse/blob/master/org-clubhouse.el][~org-clubhouse.el~]] file in this repository for +Refer to the beginning of the [[https://github.com/urbint/org-clubhouse/blob/master/org-clubhouse.el][org-clubhouse.el]] file in this repository for documentation on all supported configuration variables |