rireader 0.1.2 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. data/README.md +14 -2
  2. metadata +6 -5
  3. checksums.yaml +0 -15
  4. data/lib/rireader.rb +0 -51
data/README.md CHANGED
@@ -4,6 +4,8 @@ Ruby has a wonderful reference of the language and all available libraries: ri.
4
4
 
5
5
  ri stands for “Ruby Interactive”, which is a tool to navigate documentation.
6
6
 
7
+ This version corrected a bug which caused documentation bot to appear in some versions of Windows (e.g. Windows 7).
8
+
7
9
  Getting Started
8
10
  ==========
9
11
  If you have Ruby installed, you should have all that’s necessary to use ri. If you are have troubles, look at “Troubleshooting” below.
@@ -32,19 +34,29 @@ Enumerable#each_with_object
32
34
  Installing:
33
35
  ======
34
36
 
35
- write a simple script in any editor and save as "ri.rb" on your preferred location, this will be used to launch "Rireader".
37
+ write a simple script in any editor and save as "rireader.rbw" on your preferred location, this will be used to launch "Rireader".
38
+
39
+ ```
36
40
 
37
41
  require 'rireader'
38
- `ruby rireader`
42
+ \`ruby rireader\`
43
+
44
+ ```
45
+
46
+ (notice the backticks)
39
47
 
40
48
  Troubleshooting
41
49
  ==========
42
50
  If you are not in an RVM project and you are unable to find ri documentation, try this:
43
51
 
44
52
 
53
+ ```
54
+
45
55
  gem install rdoc rdoc-data
46
56
  rdoc-data --install
47
57
 
58
+ ```
59
+
48
60
  If you are in an RVM project, this should clear things up.
49
61
 
50
62
  rvm docs generate-ri
metadata CHANGED
@@ -1,14 +1,15 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rireader
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.2
4
+ version: 0.2.1
5
+ prerelease:
5
6
  platform: ruby
6
7
  authors:
7
8
  - Sabry Abdel Fattah
8
9
  autorequire:
9
10
  bindir: bin
10
11
  cert_chain: []
11
- date: 2015-03-03 00:00:00.000000000 Z
12
+ date: 2015-03-09 00:00:00.000000000 Z
12
13
  dependencies: []
13
14
  description: Rireader is a graphical user interface to read ri documentation for Windows
14
15
  platform.
@@ -19,11 +20,9 @@ extra_rdoc_files:
19
20
  - README.md
20
21
  files:
21
22
  - README.md
22
- - lib/rireader.rb
23
23
  homepage: http://sabryfattah.com
24
24
  licenses:
25
25
  - MIT
26
- metadata: {}
27
26
  post_install_message:
28
27
  rdoc_options:
29
28
  - --main
@@ -31,18 +30,20 @@ rdoc_options:
31
30
  require_paths:
32
31
  - lib
33
32
  required_ruby_version: !ruby/object:Gem::Requirement
33
+ none: false
34
34
  requirements:
35
35
  - - ! '>='
36
36
  - !ruby/object:Gem::Version
37
37
  version: '0'
38
38
  required_rubygems_version: !ruby/object:Gem::Requirement
39
+ none: false
39
40
  requirements:
40
41
  - - ! '>='
41
42
  - !ruby/object:Gem::Version
42
43
  version: '0'
43
44
  requirements: []
44
45
  rubyforge_project:
45
- rubygems_version: 2.4.5
46
+ rubygems_version: 1.8.29
46
47
  signing_key:
47
48
  specification_version: 3
48
49
  summary: Rireader is a graphical user interface to read ri documentation on a Windows
checksums.yaml DELETED
@@ -1,15 +0,0 @@
1
- ---
2
- !binary "U0hBMQ==":
3
- metadata.gz: !binary |-
4
- NDNlMDk3YWUzZDE1MjNmNWEyNmUxYmUyYmE0NjA4ZjU0ZmQwMjQ2Ng==
5
- data.tar.gz: !binary |-
6
- NjUwZWFhNzE2OGY3NTM4ZjA5Y2M1ZTU4MzdmYWU1ZTE4NzFhNGFmNA==
7
- SHA512:
8
- metadata.gz: !binary |-
9
- YjlhZTU1NTg2ZDEyZGZlYmI2MjliOWNhMTY2OGM4Yzg4ZWIyZjI2Y2E0NTJm
10
- MTVjNTcwZTA5MDE4YzAwYzFhYjY2NzliZTgyZDA3ZTgzZDk0NGViYzU1YjJl
11
- MmVjMjY3NDQwMjZlN2YzMGEwNTJjYzY4MjNmNGY0ZGRjYTc2MGY=
12
- data.tar.gz: !binary |-
13
- ZWMwZTVmNTE1ZWFiN2UxYjk3MGY1NzZjZGQ0MDkzYWUxYmVhOGZlNzM4Yzk1
14
- M2Y5OThjMzZjN2MyMzNiYTBkYjllZjI5N2FiZmFhNzE1ZGFmMjg3NzAzNjUw
15
- OTQ1MDRjOGQ3NGQyZmFiNTE1ZDU3YzZiYTBmZWQ1NTcwYmZkMTU=
@@ -1,51 +0,0 @@
1
- require 'tk'
2
-
3
- $var = TkVariable.new
4
-
5
- root = TkRoot.new{title "Rireader"}
6
- root['geometry'] = '1540x700+1+1'
7
-
8
- label = TkLabel.new{ text "Enter method or class name >>"
9
- borderwidth 5
10
- font TkFont.new('times 14 bold')
11
- background "yellow"
12
- relief "groove"
13
- }.pack('padx' => 60, 'pady' => 45, 'expand' => 'y')
14
-
15
- entry = TkEntry.new{
16
- textvariable $var
17
- }
18
-
19
- text = TkText.new(root){
20
- background "black"
21
- foreground "white"
22
- width 73
23
- height 19
24
- font TkFont.new('tahoma 16 bold')
25
- }
26
-
27
- button = TkButton.new{
28
- text "get ri documentation"
29
- borderwidth 5
30
- font TkFont.new('times 14 bold')
31
- background "green"
32
- relief "groove"
33
- command(proc {
34
- content = `ri --all --format=markdown "#$var"`
35
- text.delete('1.0', 'end');
36
- text.insert('1.0', "#{content}" )
37
- }
38
- )
39
- }.pack('padx' => 30, 'pady' => 15)
40
-
41
- scrollbar = TkScrollbar.new(root){command proc{|*args| text.yview(*args)}}
42
- text.yscrollcommand(proc{|first, last| scrollbar.set(first, last)})
43
-
44
- label.grid( 'row' => 0, 'column' => 1, 'sticky' => 'W')
45
- entry.grid( 'row' => 0, 'column' => 2, 'sticky' => 'W')
46
- button.grid( 'row' => 0, 'column' => 3, 'sticky' => 'WE')
47
- text.grid( 'rowspan' => 1, 'columnspan' => 4)
48
- scrollbar.grid('row' => 1, 'column' => 5, 'sticky' =>'NS')
49
-
50
- Tk.mainloop
51
-