summaryrefslogtreecommitdiffhomepage
path: root/mrbgems
diff options
context:
space:
mode:
authorYukihiro "Matz" Matsumoto <[email protected]>2020-12-19 17:31:54 +0900
committerGitHub <[email protected]>2020-12-19 17:31:54 +0900
commit8f06789cb311f31c1ab3fca534a4ab660391db75 (patch)
tree1ef2de0ec2870b6955238ba56b77a434aa772ce6 /mrbgems
parentfcc9b7fc2a6d32bd055bbb35396f3af62165a1cb (diff)
parent97eed4493f62da83f81622f5045a5c0db3ef22d2 (diff)
downloadmruby-8f06789cb311f31c1ab3fca534a4ab660391db75.tar.gz
mruby-8f06789cb311f31c1ab3fca534a4ab660391db75.zip
Merge pull request #5232 from jbampton/lint-markdown
feat(CI): add a GitHub Action to lint the Markdown
Diffstat (limited to 'mrbgems')
-rw-r--r--mrbgems/mruby-io/README.md28
-rw-r--r--mrbgems/mruby-pack/README.md31
-rw-r--r--mrbgems/mruby-sleep/README.md5
-rw-r--r--mrbgems/mruby-socket/README.md5
-rw-r--r--mrbgems/mruby-test/README.md1
5 files changed, 35 insertions, 35 deletions
diff --git a/mrbgems/mruby-io/README.md b/mrbgems/mruby-io/README.md
index 51bdbe014..db52c4a74 100644
--- a/mrbgems/mruby-io/README.md
+++ b/mrbgems/mruby-io/README.md
@@ -4,6 +4,7 @@ mruby-io
`IO` and `File` classes for mruby
## Installation
+
Add the line below to your build configuration.
```
@@ -13,6 +14,7 @@ Add the line below to your build configuration.
## Implemented methods
### IO
+
- https://doc.ruby-lang.org/ja/1.9.3/class/IO.html
| method | mruby-io | memo |
@@ -97,6 +99,7 @@ Add the line below to your build configuration.
| IO#write_nonblock | | |
### File
+
- https://doc.ruby-lang.org/ja/1.9.3/class/File.html
| method | mruby-io | memo |
@@ -167,26 +170,25 @@ Add the line below to your build configuration.
| File#size | | |
| File#truncate | | |
-
## License
Copyright (c) 2013 Internet Initiative Japan Inc.
Copyright (c) 2017 mruby developers
-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
+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
+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
+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.
diff --git a/mrbgems/mruby-pack/README.md b/mrbgems/mruby-pack/README.md
index c66945cde..efa51cc1b 100644
--- a/mrbgems/mruby-pack/README.md
+++ b/mrbgems/mruby-pack/README.md
@@ -3,8 +3,8 @@ mruby-pack (pack / unpack)
mruby-pack provides `Array#pack` and `String#unpack` for mruby.
-
## Installation
+
Add the line below into your build configuration:
```
@@ -13,8 +13,8 @@ Add the line below into your build configuration:
There is no dependency on other mrbgems.
-
## Supported template string
+
- A : arbitrary binary string (space padded, count is width)
- a : arbitrary binary string (null padded, count is width)
- C : 8-bit unsigned (unsigned char)
@@ -44,28 +44,25 @@ There is no dependency on other mrbgems.
- x : null byte
- Z : same as "a", except that null is added with *
-
-
## License
Copyright (c) 2012 Internet Initiative Japan Inc.
Copyright (c) 2017 mruby developers
-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
+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
+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
+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.
-
diff --git a/mrbgems/mruby-sleep/README.md b/mrbgems/mruby-sleep/README.md
index 68aa2c6d3..0ccc7000f 100644
--- a/mrbgems/mruby-sleep/README.md
+++ b/mrbgems/mruby-sleep/README.md
@@ -1,7 +1,9 @@
# Sleep Module for mruby
+
mruby sleep module
## install by mrbgems
+
- add conf.gem line to your build configuration.
```ruby
@@ -21,8 +23,7 @@ usleep(10000)
```
# License
+
under the MIT License:
* https://www.opensource.org/licenses/mit-license.php
-
-
diff --git a/mrbgems/mruby-socket/README.md b/mrbgems/mruby-socket/README.md
index 947a24e9e..fd20548aa 100644
--- a/mrbgems/mruby-socket/README.md
+++ b/mrbgems/mruby-socket/README.md
@@ -4,8 +4,8 @@ mruby-socket
"mruby-socket" mrbgem provides BSD socket interface for mruby.
API is compatible with CRuby's "socket" library.
-
## Example
+
```sh
% vi kame.rb
s = TCPSocket.open("www.kame.net", 80)
@@ -20,18 +20,19 @@ Date: Tue, 21 May 2013 04:31:30 GMT
```
## Requirement
+
- [mruby-io](https://github.com/mruby/mruby/tree/master/mrbgems/mruby-io) mrbgem
- [iij/mruby-mtest](https://github.com/iij/mruby-mtest) mrgbem to run tests
- system must have RFC3493 basic socket interface
- and some POSIX API...
## TODO
+
- add missing methods
- write more tests
- fix possible descriptor leakage (see XXX comments)
- `UNIXSocket#recv_io` `UNIXSocket#send_io`
-
## License
Copyright (c) 2013 Internet Initiative Japan Inc.
diff --git a/mrbgems/mruby-test/README.md b/mrbgems/mruby-test/README.md
index fa4b91e3a..c0bceecd7 100644
--- a/mrbgems/mruby-test/README.md
+++ b/mrbgems/mruby-test/README.md
@@ -4,4 +4,3 @@ Running Tests
To run the tests, execute the following from the project's root directory.
$ make test
-