Skip to content


Subversion checkout URL

You can clone with
Download ZIP
100644 88 lines (75 sloc) 4.329 kB
4984d5a @gsinclair Initial revision
gsinclair authored
1 +-----------------------------------+
2 | vim-ruby RubyForge project README |
3 +-----------------------------------+
5 Summary:
6 This project contains Vim configuration files for editing and compiling Ruby
7 within Vim. See the project homepage for more details.
9 Web links:
10 Homepage:
11 Project:
13 For regular users:
14 - The project page should have two tarballs for download:
15 - vim-ruby-stable.tar.gz (the files ready for the next Vim release)
16 - vim-ruby-devel.tar.gz (cutting-edge features we'd like you to test)
17 - Please give feedback through the bug tracking and feature request features
18 of RubyForge.
19 - Feel free to join discussions on the vim-ruby-devel mailing list.
20 Instructions on how to join are in the project page somewhere.
21 - RubyForge also features forums, but the mailing list is better.
23 For would-be contributors:
24 - Please get the latest from anonymous CVS.
25 - Please join the mailing list and discuss changes, submit patches, etc.
26 - Thank you very much for taking an interest.
28 Contents of the project:
f0d27da @dkearns offer $VIM/vimfiles and $HOME/{.vim,vimfiles} as the two default inst…
dkearns authored
29 - The compiler, ftdetect, ftplugin, indent and syntax directories contain
30 the ruby.vim files that are to be copied to a location somewhere in the Vim
31 'runtimepath'.
32 - vim-ruby-install.rb performs this copying.
4984d5a @gsinclair Initial revision
gsinclair authored
34 How you get these files into Vim:
35 - By downloading the project via a snapshot or anonymous CVS, you can keep
36 up with the latest, make changes, and install the files to a Vim
37 directory.
38 - By downloading one of the tarballs, you can easily install the latest
39 stable or development version wherever you like on your machine. No
f0d27da @dkearns offer $VIM/vimfiles and $HOME/{.vim,vimfiles} as the two default inst…
dkearns authored
40 README, no vim-ruby-install.rb, just Vim files. You would typically
41 install these into either $VIM/vimfiles, for system-wide use, or $HOME/.vim
42 ($HOME/vimfiles on Windows) for personal use.
4984d5a @gsinclair Initial revision
gsinclair authored
43 - Remember that when you install Vim in the first place, all of these files
44 are present. The purpose of downloading and installing them from
45 RubyForge is to get the latest version of them.
47 Understanding the configuration files:
48 - See
b675de0 @gsinclair * README: Minor addition.
gsinclair authored
49 - Email any one of us or ruby-talk if you want more information added to
50 this page.
4984d5a @gsinclair Initial revision
gsinclair authored
53 CVS topics:
54 - Files are tagged according to which version of Vim they are released in.
55 - The project was initiated in July 2003, when the current version of Vim
56 was 6.2. Thus every file began its life tagged as vim6_2.
57 - Modifications to the files are made in the expectation that they need to
58 be tested by interested users. They therefore (probably) don't have a
59 tag, and are available via "cvs update -A", or a development snapshot.
60 - When a modification is considered stable, it is tagged "stable".
61 Everything that is stable gets released in vim-ruby-stable.tar.gz files.
62 - When a new version of Vim is about to be released, the stable tarball is
63 contributed to it. After it has been released, the files are tagged
64 accordingly.
65 - MORAL OF THE STORY: modifications are committed to the head of the tree;
66 when they are ready for release into userland, they are tagged "stable".
68 Any questions or suggestions?
69 - If there's something about the project or its concepts that you don't
70 understand, send an email to the project maintainer, Gavin Sinclair
f03bfec @gsinclair A few improvements
gsinclair authored
71 (gsinclair at
4984d5a @gsinclair Initial revision
gsinclair authored
72 - To ask about the contents of the configuration files, ask on the mailing
73 list, as different people maintain the different files. Gavin knows
f0d27da @dkearns offer $VIM/vimfiles and $HOME/{.vim,vimfiles} as the two default inst…
dkearns authored
74 nothing about the syntax file, for instance. (Come to think of it, nor does
75 Doug - djk)
4984d5a @gsinclair Initial revision
gsinclair authored
f03bfec @gsinclair A few improvements
gsinclair authored
77 Project gossip:
78 - Two of the configuration file maintainers, Doug Kearns and Gavin Sinclair,
bf87920 @dkearns update DJK's current location again
dkearns authored
79 live in Australia (Jindabyne and Sydney respectively). Tim Hammerquist,
9692468 Minor gossip added.
Tim Hammerquist authored
80 the last man standing, has lived in the Reno/Lake Tahoe area of Nevada,
81 USA, since the late 1970s and doesn't like to gamble; a waste, really.
f03bfec @gsinclair A few improvements
gsinclair authored
82 - While the individual effort to maintain these files has a long history,
83 this actual project began in late July 2003. Therefore, if you're reading
84 this soon thereafter and something doesn't make sense, now is the time to
85 let us know.
87 --= End of Document =--
Something went wrong with that request. Please try again.