Permalink
Browse files

Fix documentations.

  • Loading branch information...
1 parent 056070a commit 1dc27ec16a3b434cb28537beee5e4b7e9bd0c633 Tomohiro Matsuyama committed Mar 21, 2010
Showing with 54 additions and 8 deletions.
  1. +2 −0 TODO.txt
  2. +26 −4 doc/manual.ja.txt
  3. +26 −4 doc/manual.txt
View
@@ -15,3 +15,5 @@
* Cloning template
* Cut branches
* Statistics
+* InstVar megamorphic
+* stubs load-path
View
@@ -36,6 +36,11 @@ RSenseはJavaで書かれた[Ruby][]のための開発補助ツールです。[U
* 呼び出し元ジャンプ
* リファクタリング
+ダウンロード
+------------
+
+[RSenseのトップページ](index.ja.txt)からダウンロードできます。
+
インストール
------------
@@ -142,6 +147,12 @@ Emacs拡張は`etc/rsense.el`にあります。次のコードを`.emacs`に追
;; $RSENSE_HOMEはRSenseをインストールしたディレクトリのフルパスに置き換えてください
(setq rsense-home "$RSENSE_HOME")
+ ;; UNIX系システムでの例
+ ;; (setq rsense-home "/home/tomo/opt/rsense-0.2")
+ ;; あるいは
+ ;; (setq rsense-home (expand-file-name "~/opt/rsense-0.2"))
+ ;; Windowsでの例
+ ;; (setq rsense-home "C:\\rsense-0.2")
(add-to-list 'load-path (concat rsense-home "/etc"))
(require 'rsense)
@@ -518,24 +529,35 @@ Rubyリファレンスマニュアル
UNIX系システム:
~~~~
- $ bin/ruby server
+ $ bin/rsense server
...
^C
- $ bin/ruby version
+ $ bin/rsenes version
RSense 0.1
~~~~
Windows:
~~~~
- > ruby bin\ruby version
- > ruby bin\ruby server
+ > ruby bin\rsense version
+ > ruby bin\rsense server
...
^C
RSense 0.1
~~~~
* EmacsやVimの設定は正しいか
+ Emacsにおける`rsense-home`やVimにおける`g:rsenseHome`は**フルパス**である必要があります。例えば、
+ ~~~~
+ (setq rsense-home "~/opt/rsense-0.2")
+ ~~~~
+ という記述は認められていません。`expand-file-name`でフルパスに展開するか、フルパスをハードコードしてください。
+ ~~~~
+ (setq rsense-home (expand-file-name "~/opt/rsense-0.2"))
+ ;; あるいは
+ (setq rsense-home "/home/tomo/opt/rsense-0.2")
+ ~~~~
+
チェックリストに問題がない場合は、RSenseの`java`と`ruby`のプロセスをキルし、pidファイルを削除したのち、最後試してください。pidファイルはUNIX系システムの場合は`$RSENSE_HOME/rsense-pid`あるいは`/tmp/rsense-pid`、Windowsの場合は`%RSENSE_HOME%\rsense-pid`にあります。
それでも問題が解決できない場合は開発者に連絡してください。
View
@@ -36,6 +36,11 @@ In the future, the following features will be also available:
* Caller jump
* Refactoring
+Downloads
+---------
+
+You can download from [RSense top page](index.txt).
+
Installation
------------
@@ -141,6 +146,12 @@ A script located at `etc\config.rb` creates a preferred config file automaticall
An Emacs extension for RSense is found at `etc/rsense.el`. Add the following code to `.emacs`:
;; Replace $RSENSE_HOME with the directory where RSense was installed in full path
+ ;; Example for UNIX-like systems
+ ;; (setq rsense-home "/home/tomo/opt/rsense-0.2")
+ ;; or
+ ;; (setq rsense-home (expand-file-name "~/opt/rsense-0.2"))
+ ;; Example for Windows
+ ;; (setq rsense-home "C:\\rsense-0.2")
(setq rsense-home "$RSENSE_HOME")
(add-to-list 'load-path (concat rsense-home "/etc"))
(require 'rsense)
@@ -517,24 +528,35 @@ Check list:
For UNIX-like systems:
~~~~
- $ bin/ruby server
+ $ bin/rsense server
...
^C
- $ bin/ruby version
+ $ bin/rsense version
RSense 0.1
~~~~
For Windows:
~~~~
- > ruby bin\ruby version
- > ruby bin\ruby server
+ > ruby bin\rsense version
+ > ruby bin\rsense server
...
^C
RSense 0.1
~~~~
* A configuration of Emacs or Vim is correct?
+ `rsense-home` variable in Emacs or `g:rsenseHome` variable in Vim should be full path. For example, the following code is not allowed at now.
+ ~~~~
+ (setq rsense-home "~/opt/rsense-0.2")
+ ~~~~
+ Use `expand-file-name` to expand to full path or write full path directly.
+ ~~~~
+ (setq rsense-home (expand-file-name "~/opt/rsense-0.2"))
+ ;; or
+ (setq rsense-home "/home/tomo/opt/rsense-0.2")
+ ~~~~
+
If there is no problem in check list, kill `java` and `ruby` processes of RSense and delete pid file located. And then try again. Pid file is located at `$RSENSE_HOME/rsense-pid` or `/tmp/rsense-pid` for UNIX-like systems, and located at `%RSENSE_HOME%\rsense-pid` for Windows.
Please contant me you couldn't resolve the problem.

0 comments on commit 1dc27ec

Please sign in to comment.