From e817e0fac94800cfff7509a649a499ea05886eb7 Mon Sep 17 00:00:00 2001
From: "Stanislav (Stas) Katkov" <sk@skylup.com>
Date: Mon, 5 Sep 2022 13:32:17 +0700
Subject: [PATCH] readme.md: add a section about generating docs

I got a bit stuck, while figuring out how to generate stdlib docs, so decided to write this down for future generations to ease onboarding into a project.

Hopefully, you'll find this useful as well.
---
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/README.md b/README.md
index a91633f..bdf1782 100644
--- a/README.md
+++ b/README.md
@@ -30,6 +30,13 @@ This will start a daemonized process, you can stop the server with:
 bundle exec rake server:stop
 ```
 
+### Generate documentation
+To generate stdlib docs, you would need to run the following:
+
+```sh
+rake stdlib:install SOURCE="$HOME/.rvm/rubies/ruby-3.1.2" VERSION="3.1.2"
+```
+
 ### Running With Docker
 
 If you have Docker installed, you can get started using `docker-compose`: