Skip to content

update README.md for prerequisite and instructions to run server locally #136

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

Merged
brunoborges merged 1 commit into from
Mar 7, 2026
Merged

update README.md for prerequisite and instructions to run server locally #136

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,15 +61,16 @@ The site supports 11 languages: English, Deutsch, Español, Português (Brasil),
### Prerequisites

- **Java 25+** (e.g. [Temurin](https://adoptium.net/))
- **JBang** ([Jbang](https://www.jbang.dev/))

### Generate and serve

```bash
# Generate all HTML pages and data/snippets.json into site/
jbang html-generators/generate.java

# Serve locally
jwebserver -b 0.0.0.0 -d site -p 8090
# Serve locally need to replace path with absolute path to site folder
jwebserver -b 0.0.0.0 -d path/to/site -p 8090
# Open http://localhost:8090
```

Expand Down