From 33bfe496d6ae732d58dbd37d137af050e80987bc Mon Sep 17 00:00:00 2001 From: prathamhole14 Date: Fri, 31 Jul 2026 23:56:31 +0530 Subject: [PATCH 1/3] add local dev setup to readme --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 18410bd..f891aaf 100644 --- a/README.md +++ b/README.md @@ -4,4 +4,35 @@ This is the GitHub repository for the Radis - Radiation Main Site. The Main Site The documentation of the Radis project is found at [radis.readthedocs.io/](https://radis.readthedocs.io/). -The website uses the template from the excellent [EinsteinPy project](https://einsteinpy.org/). Check them out! \ No newline at end of file +The website uses the template from the excellent [EinsteinPy project](https://einsteinpy.org/). Check them out! + +## Running locally + +### 1. Install Ruby + +```bash +sudo apt update +sudo apt install ruby-full build-essential zlib1g-dev -y +``` + +### 2. Configure gem path (no sudo needed for gems) + +```bash +echo 'export GEM_HOME="$HOME/gems"' >> ~/.bashrc +echo 'export PATH="$HOME/gems/bin:$PATH"' >> ~/.bashrc +source ~/.bashrc +``` + +### 3. Install Jekyll and dependencies + +```bash +gem install jekyll bundler jekyll-sitemap +``` + +### 4. Serve the site + +```bash +jekyll serve +``` + +Open [http://localhost:4000](http://localhost:4000) in your browser. Jekyll watches for file changes and reloads automatically. \ No newline at end of file From c47e8fc3681eadaed6cd87cf593b8edb6c5fa7ae Mon Sep 17 00:00:00 2001 From: prathamhole14 Date: Fri, 31 Jul 2026 23:57:15 +0530 Subject: [PATCH 2/3] make local dev guide cross-platform --- README.md | 34 ++++++++++++++-------------------- 1 file changed, 14 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index f891aaf..561cb2e 100644 --- a/README.md +++ b/README.md @@ -8,31 +8,25 @@ The website uses the template from the excellent [EinsteinPy project](https://ei ## Running locally -### 1. Install Ruby +Requires **Ruby >= 2.7**. Install it via your system's package manager or [rbenv](https://github.com/rbenv/rbenv): -```bash -sudo apt update -sudo apt install ruby-full build-essential zlib1g-dev -y -``` - -### 2. Configure gem path (no sudo needed for gems) - -```bash -echo 'export GEM_HOME="$HOME/gems"' >> ~/.bashrc -echo 'export PATH="$HOME/gems/bin:$PATH"' >> ~/.bashrc -source ~/.bashrc -``` +| OS | Install Ruby | +|---|---| +| macOS | `brew install ruby` | +| Ubuntu/Debian | `sudo apt install ruby-full build-essential zlib1g-dev` | +| Windows | [RubyInstaller](https://rubyinstaller.org/) (include DevKit) | -### 3. Install Jekyll and dependencies +Once Ruby is installed: ```bash gem install jekyll bundler jekyll-sitemap -``` - -### 4. Serve the site - -```bash jekyll serve ``` -Open [http://localhost:4000](http://localhost:4000) in your browser. Jekyll watches for file changes and reloads automatically. \ No newline at end of file +Open [http://localhost:4000](http://localhost:4000). Jekyll auto-reloads on file changes. + +> **Tip (Linux/macOS):** If you get permission errors with `gem install`, add this to your shell profile to avoid using `sudo`: +> ```bash +> export GEM_HOME="$HOME/gems" +> export PATH="$HOME/gems/bin:$PATH" +> ``` \ No newline at end of file From 407fe564cf7897a0d80b6c327443f605cbf22f45 Mon Sep 17 00:00:00 2001 From: prathamhole14 Date: Fri, 31 Jul 2026 23:58:07 +0530 Subject: [PATCH 3/3] lead with make serve in readme --- README.md | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 561cb2e..64f49d9 100644 --- a/README.md +++ b/README.md @@ -8,25 +8,23 @@ The website uses the template from the excellent [EinsteinPy project](https://ei ## Running locally -Requires **Ruby >= 2.7**. Install it via your system's package manager or [rbenv](https://github.com/rbenv/rbenv): +**With Docker (easiest):** +```bash +make serve +``` + +**Without Docker** — install Ruby first: -| OS | Install Ruby | +| OS | Command | |---|---| | macOS | `brew install ruby` | | Ubuntu/Debian | `sudo apt install ruby-full build-essential zlib1g-dev` | | Windows | [RubyInstaller](https://rubyinstaller.org/) (include DevKit) | -Once Ruby is installed: - +Then: ```bash gem install jekyll bundler jekyll-sitemap jekyll serve ``` -Open [http://localhost:4000](http://localhost:4000). Jekyll auto-reloads on file changes. - -> **Tip (Linux/macOS):** If you get permission errors with `gem install`, add this to your shell profile to avoid using `sudo`: -> ```bash -> export GEM_HOME="$HOME/gems" -> export PATH="$HOME/gems/bin:$PATH" -> ``` \ No newline at end of file +Open [http://localhost:4000](http://localhost:4000). Jekyll auto-reloads on file changes. \ No newline at end of file