aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTim Smith <tsmith@mondoo.com>2022-04-17 21:53:43 -0700
committerHiroshi SHIBATA <hsbt@ruby-lang.org>2022-04-19 08:32:37 +0900
commit810b9c344a40802d7736282d86e51d48e8b336a4 (patch)
treefc29a1b466b0f8b2b08b0dc20ea4e76bc61e020a /README.md
parent4299375b9b8b49b02b3d131bfbc621cf28752fae (diff)
downloadruby-810b9c344a40802d7736282d86e51d48e8b336a4.tar.gz
Resolve several markedown warnings
- Spaces before and after blocks. - Single spaces after sentences everywhere Signed-off-by: Tim Smith <tsmith@mondoo.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 17 insertions, 20 deletions
diff --git a/README.md b/README.md
index 3abbcba810..32392479cb 100644
--- a/README.md
+++ b/README.md
@@ -15,18 +15,17 @@ It is simple, straightforward, and extensible.
## Features of Ruby
-* Simple Syntax
-* **Normal** Object-oriented Features (e.g. class, method calls)
-* **Advanced** Object-oriented Features (e.g. mix-in, singleton-method)
-* Operator Overloading
-* Exception Handling
-* Iterators and Closures
-* Garbage Collection
-* Dynamic Loading of Object Files (on some architectures)
-* Highly Portable (works on many Unix-like/POSIX compatible platforms as
- well as Windows, macOS, etc.) cf.
- https://github.com/ruby/ruby/blob/master/doc/maintainers.rdoc#label-Platform+Maintainers
-
+* Simple Syntax
+* **Normal** Object-oriented Features (e.g. class, method calls)
+* **Advanced** Object-oriented Features (e.g. mix-in, singleton-method)
+* Operator Overloading
+* Exception Handling
+* Iterators and Closures
+* Garbage Collection
+* Dynamic Loading of Object Files (on some architectures)
+* Highly Portable (works on many Unix-like/POSIX compatible platforms as
+ well as Windows, macOS, etc.) cf.
+ https://github.com/ruby/ruby/blob/master/doc/maintainers.rdoc#label-Platform+Maintainers
## How to get Ruby
@@ -60,7 +59,6 @@ Try the following command to see the list of branches:
$ svn ls https://svn.ruby-lang.org/repos/ruby/branches/
-
## Ruby home page
https://www.ruby-lang.org/
@@ -90,10 +88,10 @@ is required.
## How to compile and install
-1. If you want to use Microsoft Visual C++ to compile Ruby, read
+1. If you want to use Microsoft Visual C++ to compile Ruby, read
[win32/README.win32](rdoc-ref:win32/README.win32) instead of this document.
-2. Run `./autogen.sh` to generate configure, when you build the source checked
+2. Run `./autogen.sh` to generate configure, when you build the source checked
out from the Git repository.
3. Run `./configure`, which will generate `config.h` and `Makefile`.
@@ -104,7 +102,7 @@ is required.
4. Edit `include/ruby/defines.h` if you need. Usually this step will not be needed.
-5. Optional: Remove comment mark(`#`) before the module names from `ext/Setup`.
+5. Optional: Remove comment mark(`#`) before the module names from `ext/Setup`.
This step is only necessary if you want to link modules statically.
@@ -114,16 +112,16 @@ is required.
Usually this step will not be needed.
-6. Run `make`.
+6. Run `make`.
* On Mac, set RUBY\_CODESIGN environment variable with a signing identity.
It uses the identity to sign `ruby` binary. See also codesign(1).
-7. Optionally, run '`make check`' to check whether the compiled Ruby
+7. Optionally, run '`make check`' to check whether the compiled Ruby
interpreter works well. If you see the message "`check succeeded`", your
Ruby works as it should (hopefully).
-8. Run '`make install`'.
+8. Run '`make install`'.
This command will create the following directories and install files into
them.
@@ -145,7 +143,6 @@ is required.
* `${DESTDIR}${prefix}/share/man/man1`
* `${DESTDIR}${prefix}/share/ri/${MAJOR}.${MINOR}.${TEENY}/system`
-
If Ruby's API version is '*x.y.z*', the `${MAJOR}` is '*x*', the
`${MINOR}` is '*y*', and the `${TEENY}` is '*z*'.