Permalink
Browse files

Updated README + Manifest

  • Loading branch information...
1 parent 1104cba commit fe2960c30d392713f90273755b16c1a5f7247986 @js js committed Mar 29, 2009
Showing with 12 additions and 5 deletions.
  1. +7 −2 Manifest.txt
  2. +5 −3 README.txt
View
@@ -1,7 +1,12 @@
+.gitignore
History.txt
Manifest.txt
README.txt
Rakefile
-bin/simple_mmap
+ext/extconf.rb
+ext/mapped_file.c
lib/simple_mmap.rb
-test/test_simple_mmap.rb
+lib/simple_mmap/file_window.rb
+lib/simple_mmap/version.rb
+test/test_file_window.rb
+test/test_mapped_file.rb
View
@@ -1,14 +1,15 @@
= simple_mmap
-* FIX (url)
+http://simple-mmap.rubyforge.org/
== DESCRIPTION:
A simplistic interface for reading memory mapped files
== FEATURES/PROBLEMS:
-* FIX (list of features or problems)
+* mmap a file. Read data from it. Close it when you're done. More fun than the "ball in a cup" game.
+* it ONLY supports reading mmap'ed files, not writing to the mmap'ed region
== SYNOPSIS:
@@ -17,13 +18,14 @@
# works with the same semantics as Array#[] (eg. fw[10..14] and fw[10...14])
>> fw.close # you MUST close the FileWindow after you're done (HAHA no blocks for you yet!)
+
== REQUIREMENTS:
* A mmap() capable platform.
== INSTALL:
-* FIX (sudo gem install, anything else)
+gem install simple-mmap
== LICENSE:

0 comments on commit fe2960c

Please sign in to comment.