Skip to content

Commit 5714b84

Browse files
committed
Reorganize to make gem install procedure more prominent.
1 parent 3f1c3ef commit 5714b84

File tree

1 file changed

+37
-30
lines changed

1 file changed

+37
-30
lines changed

README

Lines changed: 37 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,36 @@
1-
Author:: Sam Roberts <sroberts@uniserve.com>
1+
Author:: Sam Roberts <vieuxtech@gmail.com>
22
Copyright:: Copyright (C) 2008 Sam Roberts
33
License:: May be distributed under the same terms as Ruby
44
Homepage:: http://vpim.rubyforge.org
55
Download:: http://rubyforge.org/projects/vpim
6+
Install:: sudo gem install vpim
67

7-
This is a pure-ruby library for decoding and encoding vCard and iCalendar data
8-
("personal information") called vPim.
8+
vPim provides calendaring, scheduling, and contact support for Ruby through the
9+
standard iCalendar and vCard data formats for "personal information" exchange.
10+
11+
= Thanks
12+
13+
- http://ZipDX.com: for sponsoring development of FREQ=weekly and BYSETPOS in
14+
recurrence rules.
15+
- http://RubyForge.org: for their generous hosting of this project.
16+
17+
= Installation
18+
19+
There is a vPim package installable using ruby-gems:
20+
21+
# sudo gem install vpim (may require root privilege)
22+
23+
It is also installable in the standard way. Untar the package, and do:
24+
25+
$ ruby setup.rb --help
26+
27+
or do:
28+
29+
$ ruby setup.rb config
30+
$ ruby setup.rb setup
31+
# ruby setup.rb install (may require root privilege)
32+
33+
= Overview
934

1035
vCard (RFC 2426) is a format for personal information, see Vpim::Vcard and
1136
Vpim::Maker::Vcard.
@@ -23,23 +48,6 @@ instantaneous turnaround, but I might be able to suggest another approach, and
2348
features requested by users of vPim go to the top of the todo list. If you need
2449
a feature for a commercial project, consider sponsoring development.
2550

26-
= Project Information
27-
28-
The latest release can be downloaded from the Ruby Forge project page:
29-
30-
- http://rubyforge.org/projects/vpim
31-
32-
For notifications about new releases, or asking questions about vPim, please
33-
subscribe to "vpim-talk":
34-
35-
- http://rubyforge.org/mailman/listinfo/vpim-talk
36-
37-
= Thanks
38-
39-
- http://RubyForge.org: for their generous hosting of this project.
40-
- http://ZipDX.com: for sponsoring development of FREQ=weekly and BYSETPOS in
41-
recurrence rules.
42-
4351
= Examples
4452

4553
Here's an example to give a sense for how iCalendars are encoded and decoded:
@@ -156,20 +164,19 @@ iCalendar examples are:
156164
Apple's iCal calendars
157165
- link:rrule.txt: utility for printing recurrence rules
158166
- link:ics-dump.txt: utility for dumping contents of .ics files
159-
module Vpim
160-
end
161167

162-
= Installation
168+
= Project Information
163169

164-
There is a vPim package installable using ruby-gems.
170+
vPim can be downloaded from the Ruby Forge project page:
165171

166-
It is also installable in the standard way. Untar the package, and see:
172+
- http://rubyforge.org/projects/vpim
167173

168-
ruby setup.rb --help
174+
or installed as a gem:
169175

170-
or do:
176+
- sudo gem install vpim
171177

172-
$ ruby setup.rb config
173-
$ ruby setup.rb setup
174-
# ruby setup.rb install (may require root privilege)
178+
For notifications about new releases, or to ask questions about vPim, please
179+
subscribe to "vpim-talk":
180+
181+
- http://rubyforge.org/mailman/listinfo/vpim-talk
175182

0 commit comments

Comments
 (0)