Skip to content

Improve README with local dev setup and instructions #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
prathamhole14 wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Improve README with local dev setup and instructions #8

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
33bfe49
add local dev setup to readme
prathamhole14 Jul 31, 2026
c47e8fc
make local dev guide cross-platform
prathamhole14 Jul 31, 2026
407fe56
lead with make serve in readme
prathamhole14 Jul 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,27 @@ 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!
The website uses the template from the excellent [EinsteinPy project](https://einsteinpy.org/). Check them out!

## Running locally

**With Docker (easiest):**
```bash
make serve
```

**Without Docker** — install Ruby first:

| OS | Command |
|---|---|
| macOS | `brew install ruby` |
| Ubuntu/Debian | `sudo apt install ruby-full build-essential zlib1g-dev` |
| Windows | [RubyInstaller](https://rubyinstaller.org/) (include DevKit) |

Then:
```bash
gem install jekyll bundler jekyll-sitemap
jekyll serve
```

Open [http://localhost:4000](http://localhost:4000). Jekyll auto-reloads on file changes.