summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorAkira Yumiyama <[email protected]>2013-04-01 09:21:12 +0900
committerAkira Yumiyama <[email protected]>2013-04-01 09:21:12 +0900
commitb8a23e6be8e8d1047358a4b548ba5241f8503288 (patch)
tree1a25732f627c7bf61e7696600f2a68eb78e386fc
parente8ca5e516983fe720ec46887744f0d21b8f16ce1 (diff)
downloadmruby-b8a23e6be8e8d1047358a4b548ba5241f8503288.tar.gz
mruby-b8a23e6be8e8d1047358a4b548ba5241f8503288.zip
update README.md
-rw-r--r--README.md182
-rw-r--r--mrbgem.rake2
2 files changed, 182 insertions, 2 deletions
diff --git a/README.md b/README.md
index 01d29521a..d90669ea1 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,185 @@
mruby-io
========
-under construction
+IO, File module for mruby
+
+
+## License
+
+Copyright (c) 2013 Internet Initiative Japan Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+
+## Implement methods
+
+### IO
+ - http://doc.ruby-lang.org/ja/1.9.3/class/IO.html
+
+| method | mruby-io | memo |
+| ------------------------- | -------- | ---- |
+| IO.binread | | |
+| IO.binwrite | | |
+| IO.copy_stream | | |
+| IO.new, IO.for_fd, IO.open | o | |
+| IO.foreach | | |
+| IO.pipe | | |
+| IO.popen | o | |
+| IO.read | | |
+| IO.readlines | | |
+| IO.select | | |
+| IO.sysopen | o | |
+| IO.try_convert | | |
+| IO.write | | |
+| IO#<< | | |
+| IO#advise | | |
+| IO#autoclose= | | |
+| IO#autoclose? | | |
+| IO#binmode | | |
+| IO#binmode? | | |
+| IO#bytes | | obsolete |
+| IO#chars | | obsolete |
+| IO#clone, IO#dup | | |
+| IO#close | o | |
+| IO#close_on_exec= | | |
+| IO#close_on_exec? | | |
+| IO#close_read | | |
+| IO#close_write | | |
+| IO#closed? | o | |
+| IO#codepoints | | obsolete |
+| IO#each_byte | o | |
+| IO#each_char | o | |
+| IO#each_codepoint | | |
+| IO#each_line | o | |
+| IO#eof, IO#eof? | o | |
+| IO#external_encoding | | |
+| IO#fcntl | | |
+| IO#fdatasync | | |
+| IO#fileno, IO#to_i | | |
+| IO#flush | | |
+| IO#fsync | | |
+| IO#getbyte | | |
+| IO#getc | o | |
+| IO#gets | o | |
+| IO#internal_encoding | | |
+| IO#ioctl | | |
+| IO#isatty, IO#tty? | | |
+| IO#lineno | | |
+| IO#lineno= | | |
+| IO#lines | | obsolete |
+| IO#pid | o | |
+| IO#pos, IO#tell | o | |
+| IO#pos= | o | |
+| IO#print | o | |
+| IO#printf | o | |
+| IO#putc | | |
+| IO#puts | o | |
+| IO#read | o | |
+| IO#read_nonblock | | |
+| IO#readbyte | | |
+| IO#readchar | o | |
+| IO#readline | o | |
+| IO#readlines | o | |
+| IO#readpartial | | |
+| IO#reopen | | |
+| IO#rewind | | |
+| IO#seek | o | |
+| IO#set_encoding | | |
+| IO#stat | | |
+| IO#sync | | |
+| IO#sync= | | |
+| IO#sysread | o | |
+| IO#sysseek | o | |
+| IO#syswrite | o | |
+| IO#to_io | | |
+| IO#ungetbyte | | |
+| IO#ungetc | o | |
+| IO#write | o | |
+| IO#write_nonblock | | |
+
+### File
+ - http://doc.ruby-lang.org/ja/1.9.3/class/File.html
+
+| method | mruby-io | memo |
+| --------------------------- | -------- | ---- |
+| File.absolute_path | | |
+| File.atime | | |
+| File.basename | o | |
+| File.blockdev? | | FileTest |
+| File.chardev? | | FileTest |
+| File.chmod | | |
+| File.chown | | |
+| File.ctime | | |
+| File.delete, File.unlink | o | |
+| File.directory? | o | FileTest |
+| File.dirname | o | |
+| File.executable? | | FileTest |
+| File.executable_real? | | FileTest |
+| File.exist?, exists? | o | FileTest |
+| File.expand_path | | |
+| File.extname | o | |
+| File.file? | o | FileTest |
+| File.fnmatch, File.fnmatch? | | |
+| File.ftype | | |
+| File.grpowned? | | FileTest |
+| File.identical? | | FileTest |
+| File.join | o | |
+| File.lchmod | | |
+| File.lchown | | |
+| File.link | | |
+| File.lstat | | |
+| File.mtime | | |
+| File.new, File.open | o | |
+| File.owned? | | FileTest |
+| File.path | | |
+| File.pipe? | o | FileTest |
+| File.readable? | | FileTest |
+| File.readable_real? | | FileTest |
+| File.readlink | | |
+| File.realdirpath | | |
+| File.realpath | o | |
+| File.rename | o | |
+| File.setgid? | | FileTest |
+| File.setuid? | | FileTest |
+| File.size | o | |
+| File.size? | o | FileTest |
+| File.socket? | o | FileTest |
+| File.split | | |
+| File.stat | | |
+| File.sticky? | | FileTest |
+| File.symlink | | |
+| File.symlink? | o | FileTest |
+| File.truncate | | |
+| File.umask | o | |
+| File.utime | | |
+| File.world_readable? | | |
+| File.world_writable? | | |
+| File.writable? | | FileTest |
+| File.writable_real? | | FileTest |
+| File.zero? | o | FileTest |
+| File#atime | | |
+| File#chmod | | |
+| File#chown | | |
+| File#ctime | | |
+| File#flock | | |
+| File#lstat | | |
+| File#mtime | | |
+| File#path, File#to_path | o | |
+| File#size | | |
+| File#truncate | | |
diff --git a/mrbgem.rake b/mrbgem.rake
index 10e192c45..029af4d26 100644
--- a/mrbgem.rake
+++ b/mrbgem.rake
@@ -1,6 +1,6 @@
MRuby::Gem::Specification.new('mruby-io') do |spec|
spec.license = 'MIT'
- spec.authors = 'Internet Initiative Japan'
+ spec.authors = 'Internet Initiative Japan Inc.'
spec.cc.include_paths << "#{build.root}/src"
end