diff options
| -rw-r--r-- | CONTRIBUTING.org | 23 | ||||
| -rw-r--r-- | README.org | 73 |
2 files changed, 63 insertions, 33 deletions
diff --git a/CONTRIBUTING.org b/CONTRIBUTING.org new file mode 100644 index 0000000..3fcf111 --- /dev/null +++ b/CONTRIBUTING.org @@ -0,0 +1,23 @@ +If you need help, search the issue tracker to see if anyone has asked +your question before. If it hasn't, a good place to ask first is our +chat room on [[https://gitter.im/vermiculus/sx.el][Gitter]]. Opening an issue is welcome of course, but chat +will likely be faster for you. If a code change needs to be made, an +issue can be written up as necessary. + +Have a great idea for SX? Again, discuss it on [[https://gitter.im/vermiculus/sx.el][Gitter]] first! Don't +limit ideas to mimicking the official website, either -- this is +Emacs; we should take advantage of its abilities. + +To see what we're working on /right now/, check out our [[http://www.waffle.io/vermiculus/sx.el][Waffle board]]. +If you would like to contribute, feel free to take on anything in the +=ready= Waffle column (or the [[https://github.com/vermiculus/sx.el/issues?q=is%3Aopen+is%3Aissue+label%3Aready+-label%3A%22in+progress%22][=ready= GitHub label]]). These are issues +which have been discussed enough to provide a good idea of what should +be done. Issues in =backlog= are either still under discussion or +simply are in the backlog. + +Of course, the greatest gift you can give to SX is a good word. Star +the project on GitHub, mention it to others who would use it in your +StackExchange chat rooms (as always, be courteous and respectful), and +use it yourself. + +Enjoy! @@ -4,58 +4,61 @@ [[https://gitter.im/vermiculus/sx.el?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/sx.el][https://badge.waffle.io/vermiculus/sx.el.svg]] -SX will be a full featured Stack Exchange mode for GNU Emacs 24+. -Using the official API, we aim to create a more versatile experience -for the Stack Exchange network within Emacs itself. +SX will be a full featured Stack Exchange mode for GNU Emacs 24+. Using the +official API, we aim to create a more versatile experience for the Stack +Exchange network within Emacs itself. * Features -- ~sx-tab-frontpage~ :: - List questions on a StackExchange site. -- Viewing Posts :: - - Use =jknp= to open questions from within ~list-questions~; use - =RET= to move focus. - - Use =v= to open the object at point in your browser. - - Use =TAB= to fold questions and answers. - - Use =RET= to open a link at point. - - Use =:= to switch sites. - - Vote up and down with =u= and =d=. +** Viewing Questions +View questions with one of the ~sx-tab-~ commands. These translate to the +different 'tabs' that you can view on the official site. Implemented tabs +include: +- =frontpage= :: The default front page of questions. +- =newest= :: Newest questions first. +- =topvoted= :: Highest-voted questions first. +- =hot= :: Questions with the most views, answers, and votes over the last few + days. +- =week= :: Questions with the most views, answers, and votes this week. +- =month= :: Questions with the most views, answers, and votes this month. +The meaning of these tabs hopefully needs no explanation, but the official +behavior is given as a tooltip on any site in the StackExchange network. -** Planned -- Archiving questions for offline access -- Browsing and favoriting networks -- Advanced searching -- Writing questions, answers, and comments (with source code in its - native major mode) -- Notifications -- Reputation reporting -- ... +Each of these opens up a list of questions. Switch sites with =:=. Navigate +this list of questions with =jk= or =np=. =jk= will also view the question in a +separate buffer. =v= will visit the question in your browser where =w= will +simply copy a link. Upvote and downvote with =u= and =d=. =RET= will take you +to the question buffer, where =RET= on headlines will expand and collapse each +section. Add comments with =c=. -Have a feature in mind that isn't on the list? Submit a pull request -to add it to the list! If you want to discuss it first, pop in our -Gitter chatroom (badge above) -- someone will be around shortly to -talk about it. +As always, =C-h m= is the definitive resource for the functions of this mode. * Installation To install the development version, follow the usual steps: - Clone this repository - Add this directory to your ~load-path~ - Issue ~(require 'sx)~ -This should give you access to the only entry point function at the -moment, ~sx-tab-frontpage~. +- Issue ~(require 'sx-tab)~ +This should give you access to the ~sx-tab-~ functions (the main entry points at +this time). + +If you are going to be doing any asking / answering / commenting / upvoting / +downvoting / /etc./, you must use ~sx-authenticate~ to provide SX with an +authentication token to act on your behalf. Eventually, this package will be available on MELPA. * Contributing -Please help contribute! Doing any of the following will help us immensely: +Please help contribute! Doing any of the following will help us immensely: - [[https://github.com/vermiculus/sx.el/issues/new][Open an issue]] - [[https://github.com/vermiculus/sx.el/pulls][Submit a pull request]] - [[https://gitter.im/vermiculus/sx.el][Suggest a package or library in our Chat on Gitter]] (or just hang out =:)=) - Spread the word! -For a better view of all of the open issues, take a look at our lovely -[[http://www.waffle.io/vermiculus/sx.el][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! +For a better view of all of the open issues, take a look at our lovely [[http://www.waffle.io/vermiculus/sx.el][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! + +See also =CONTRIBUTING.org=. * Resources - [[http://www.gnu.org/software/emacs/][GNU Emacs]] @@ -68,3 +71,7 @@ it. - [[file:resources/emacs.svg][Emacs icon]] - [[file:resources/stackexchange.svg][Stack Exchange icon]] +* COMMENT Local Variables +# Local Variables: +# fill-column: 80 +# End: |