summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHiroshi SHIBATA <hsbt@ruby-lang.org>2023-01-20 17:42:50 +0900
committerHiroshi SHIBATA <hsbt@ruby-lang.org>2023-01-20 17:42:50 +0900
commit6aa9c84500ceb9859a4b9bf08d296d3377988454 (patch)
tree5771727706512bdddc2f6aeef289424b1c2aa2ce
parentea10dea6c7cb2347a12228151795b14e79d96391 (diff)
Separate dependencies section from quick start
-rw-r--r--doc/contributing/building_ruby.md18
1 files changed, 10 insertions, 8 deletions
diff --git a/doc/contributing/building_ruby.md b/doc/contributing/building_ruby.md
index bec90e287a..63e3a4f429 100644
--- a/doc/contributing/building_ruby.md
+++ b/doc/contributing/building_ruby.md
@@ -1,6 +1,6 @@
# Building Ruby
-## Quick start guide
+## Dependencies
1. Install the prerequisite dependencies for building the CRuby interpreter:
@@ -30,19 +30,21 @@
done
```
-3. Checkout the CRuby source code:
+## Quick start guide
+
+1. Checkout the CRuby source code:
``` shell
git clone https://github.com/ruby/ruby.git
```
-4. Generate the configure file:
+2. Generate the configure file:
``` shell
./autogen.sh
```
-5. Create a `build` directory outside of the source directory:
+3. Create a `build` directory outside of the source directory:
``` shell
mkdir build && cd build
@@ -50,13 +52,13 @@
While it's not necessary to build in a separate directory, it's good practice to do so.
-6. We'll install Ruby in `~/.rubies/ruby-master`, so create the directory:
+4. We'll install Ruby in `~/.rubies/ruby-master`, so create the directory:
``` shell
mkdir ~/.rubies
```
-7. Run configure:
+5. Run configure:
``` shell
../configure --prefix="${HOME}/.rubies/ruby-master"
@@ -64,13 +66,13 @@
- If you are frequently building Ruby, add the `--disable-install-doc` flag to not build documentation which will speed up the build process.
-8. Build Ruby:
+6. Build Ruby:
``` shell
make install
```
-9. [Run tests](testing_ruby.md) to confirm your build succeeded.
+7. [Run tests](testing_ruby.md) to confirm your build succeeded.
### Unexplainable Build Errors