Skip to content

Commit

Permalink
wrote documents
Browse files Browse the repository at this point in the history
  • Loading branch information
hayamiz committed Dec 28, 2009
1 parent 4cf58f7 commit 8524a47
Show file tree
Hide file tree
Showing 3 changed files with 90 additions and 20 deletions.
40 changes: 40 additions & 0 deletions INSTALL
@@ -0,0 +1,40 @@
<!-- -*- mode: markdown -*- -->

Installation Guide
==================

For Windows users
-----------------

* For those who do not have cURL binaries:
* Copy `twittering-mode.el` and `win-curl` to the same directory,
which is included in `load-path` of your Emacs environment.
* Proceed to **Set up your Emacs**
* Others:
* Copy `twittering-mode.el` to the directory included in
`load-path`.
* Proceed to **Set up your Emacs**

For Linux and other Unix users
------------------------------

* Copy `twittering-mode.el` to the directory included in `load-path`
of your Emacs environment.
* (Optional) Install cURL in your way. For example, `apt-get install
curl` would do in Debian and its variants.

Set up your Emacs
-----------------

* Add following code to your `.emacs`:

(add-to-list 'load-path "/path/to/installed/dir") ;; if you need
(require 'twittering-mode)
(setq twittering-username "your twitter ID")

Run twittering-mode
-------------------

1. Execute `M-x twit` to run twittering-mode.
2. Enter the password which is prompted.
3. Your friends' timeline will appear. Enjoy!
20 changes: 0 additions & 20 deletions README

This file was deleted.

50 changes: 50 additions & 0 deletions README.markdown
@@ -0,0 +1,50 @@
Twittering-mode: a Twitter client for Emacs
=============================================

Twittering-mode enables you to twit on Emacsen.

- web: http://twmode.sf.net
- github: http://github.com/hayamiz/twittering-mode

Features
----------

* Activities on Twitter
* Viewing various timelines
* Friends' timeline
* Replies
* User's timeline
* Public timeline
* Posting tweets
* Direct message
* ReTweet
* Hash tag
* Signiture
* Following and removing users
* Marking tweets as favorites
* HTTP Proxy support
* Secure connection via HTTPS (cURL is required)

Supported Emacsen
-------------------

- GNU Emacs 21 (some restrictions)
- GNU Emacs 22, 23

Authors & Contributors
------------------------

- Y. Hayamizu
- naoya_t
- Tsuyoshi CHO
- Alberto Garcia
- Satoshi Yatagawa
- 高山智也
- 松尾(cvmat)
- 青田(naota)
- Jaemok Jeong(jmjeong)

See also
----------

- http://www.emacswiki.org/emacs-en/TwitteringMode

0 comments on commit 8524a47

Please sign in to comment.