diff options
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 84 |
1 files changed, 13 insertions, 71 deletions
@@ -4,83 +4,25 @@ [[https://travis-ci.org/vermiculus/stack-mode][https://travis-ci.org/vermiculus/stack-mode.svg?branch=master]] [[https://gitter.im/vermiculus/stack-mode?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge][https://badges.gitter.im/Join Chat.svg]] +[[https://www.waffle.io/vermiculus/stack-mode][https://badge.waffle.io/vermiculus/stack-mode.svg]] -=stack-mode= hopes to be a fully-featured Stack Exchange mode for -Emacs 24+ using version 2.2 (and subsequent versions as available) of -the Stack Exchange API. +=stack-mode= hopes to be a full featured Stack Exchange mode for +[[http://www.gnu.org/software/emacs/][GNU Emacs]] 24+ using version 2.2 (and subsequent versions as available) of +the [[https://api.stackexchange.com/][Stack Exchange API]]. This README will eventually hold a high-level feature list and details on installation and configuration. * Contributing -Please do, but note that the repository history is likely to be -rebased on a single commit once v0.1 is reached. Things at this stage -are volatile and highly experimental, so the codebase changes quickly -and sometimes arbitrarily. +Please help contribute! Doing any of the following will help us immensely: + - [[https://github.com/vermiculus/stack-mode/issues/new][Open an issue]] + - [[https://github.com/vermiculus/stack-mode/pulls][Submit a pull request]] + - Suggest a package or library in our [[https://gitter.im/vermiculus/stack-mode][Chat on Gitter]] + - Spread the word! -The best way to contribute right now is via discussion. Open an issue -describing a feature you'd like (That isn't already listed) or a -package you think would come in handy. -** Wishlist -- Automatic testing system (usable with Travis CI) :: Along with - unit-testing, it would be best to have this done in Travis CI so - that pull requests can be examined before merge. -- OAuth :: Without this, we can't write with the API. This is - obviously something we want to do, but I don't understand - even /regular/ OAuth (web server -- web server). If - someone can take care of this, I'd be forever grateful. -- Persistent Data :: It would cut down on requests if StackMode could - implement a persistent, expirable cache. -* Planned Features -** Network Exploration -#+BEGIN_EXAMPLE - Logged in as Sean - - 14 unread inbox items - 1 unread notification - - Favorites............................................................. - Emacs emacs - TeX, LaTeX, and Friends tex - StackOverflow stackoverflow - StackApps stackapps - Mathematics math - - Other Sites........................................................... - <all other sites> -#+END_EXAMPLE -** Question Viewing -It's not terribly clear how this whould be approached, but I have in -the past assumed using an Org-mode-like buffer (with special bindings) -that includes the question and all answers and comments. This is -likely to evolve as the project better understands what it is. - -Whatever the format, the user will be able to archive the question for -offline reference. -** Question Browsing -If point is on a question: -#+BEGIN_EXAMPLE - Full title: AUCTeX, preview-latex, and Ghostscript (Emacs) - Asker: vermiculus (572) - Answers: 1 (Not Accepted) Active: [2013-02-27 Wed 15:44] - Tags: emacs auctex preview ghostscript - Bounty: 50 -#+END_EXAMPLE -Else: -#+BEGIN_EXAMPLE - Site: TeX, LaTeX, and Friends - Users: 400 - Unanswered: 15 (0.003) -#+END_EXAMPLE -The information displays (and its format) will be customizable using -format strings and special markers. -** Question Asking -** Commenting -With a pop-up buffer similar to =twittering-mode=. -** Not Planned -The following features are not currently planned for this mode, -regardless of API support. This is mostly because I have no idea what -I'm doing. -- chat +For a better view of all of the open issues, take a look at our lovely +[[http://www.waffle.io/vermiculus/stack-mode][Waffle board]]. Feel free to take the torch on anything in =backlog= or +=ready=. If you have thoughts on any other issues, don't hesitate to +chime in! * Resources - [[https://api.stackexchange.com/docs][SX.API v2.2]] - [[http://stackapps.com/apps/oauth/register][StackApps Registration Page]] |