Skip to content

Commit

Permalink
updated install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
hayamiz committed Jun 4, 2010
1 parent b8fdb31 commit 10e0ec8
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 28 deletions.
36 changes: 21 additions & 15 deletions INSTALL
Original file line number Diff line number Diff line change
Expand Up @@ -6,35 +6,41 @@ 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**
* Uncompress the archive file, and add a path of a directory
containing `twittering-mode.el` to your `load-path`.
* For example, if you uncompressed it under `C:\foo\`, there may be
a directory `C:\foo\twittering-mode-X.X.X\` which contains
`twittering-mode.el`. So add the following code to your `.emacs`

(add-to-list 'load-path "C:/foo/twittering-mode-X.X.X")

* 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.
* Uncompress the archive file, and add a path of a directory
containing `twittering-mode.el` to your `load-path`.
* For example, if you uncompressed it under `/path/to/foo`, there may be
a directory `/path/to/foo/twittering-mode-X.X.X/` which contains
`twittering-mode.el`. So add the following code to your `.emacs`

(add-to-list 'load-path "/path/to/foo/twittering-mode-X.X.X")

* Install cURL, gnutls, or openssl for using SSL connection.
* Proceed to **Set up your Emacs**

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.
2. Open OAuth authorization page with your browser, click "Allow", and
enter the PIN code.
3. Your friends' timeline will appear. Enjoy!
37 changes: 24 additions & 13 deletions INSTALL.ja
Original file line number Diff line number Diff line change
Expand Up @@ -6,33 +6,44 @@
Windows
---------

* cURLのプログラムを持っていない、またはわからない人:
* `twittering-mode.el``win-curl`を、Emacsの`load-path`に含まれてい
るディレクトリにコピーする
* **Emacsの設定** へ進む
* cURLを持っている人:
* `twittering-mode.el`をEmacsの`load-path`に含まれているディレクトリへコピー
* **Emacsの設定** へ進む
* twittering-modeのファイルを展開して現れたディレクトリを`load-path`
追加する。
* 例: `C:\foo\`というディレクトリの下に展開したとすると、
`twittering-mode.el`が入っているディレクトリ
`C:\foo\twittering-mode-X.X.X\`があるはずなので、`.emacs`に次の内容
を追加する:

(add-to-list 'load-path "C:/foo/twittering-mode-X.X.X")

* **Emacsの設定** へ進む

Linuxやその他Unix環境
-----------------------

* `twittering-mode.el`をEmacsの`load-path`に含まれているディレクトリへコピー
* cURLをインストールする。例えばDebianやその派生ディストリビューション
では `apt-get install curl` でcURLがインストールできる
* twittering-modeのファイルを展開して現れたディレクトリを`load-path`
追加する。
* 例: `/path/to/foo`というディレクトリの下に展開したとすると、
`twittering-mode.el`が入っているディレクトリ
`/path/to/foo/twittering-mode-X.X.X/`があるはずなので、`.emacs`に次の内容
を追加する:

(add-to-list 'load-path "/path/to/foo/twittering-mode-X.X.X")

* SSL通信を利用するためには、cURL、gnutls、opensslのどれかをインストー
ルしておく
* **Emacsの設定** へ進む

Emacsの設定
-------------

* 次のコードを`.emacs`に追加する:

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

twittering-modeを動かす
-------------------------

1. `M-x twit`を実行
2. パスワードを入力
2. 画面の指示に従いOAuthの認証ページを開き、"Allow"ボタンをクリックして、
表示されたPINコードをEmacsに入力する
3. Twitterのタイムラインが表示されるはず!

0 comments on commit 10e0ec8

Please sign in to comment.