Skip to content
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

Jump to bottom

update documentation of how to run the code #554

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

update documentation of how to run the code #554

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
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,13 @@ cd www
### Installation
Install Ruby and the Gem package manager (pre-installed in Mac OS X) and install `jekyll` and its related packages available in the Github hosted version by running, from this directory:

bundle install;
bundle install
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

### Running
Jekyll can run a local web server that rebuilds each time you save a page while editing (Execute the below command from root directory):

bundle exec jekyll serve --incremental;
`jekyll serve`: rebuilds the entire website from scratch each time.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing bundle exec.

Narrative is up against the command. Please break the line, as is the style now in use.


`bundle exec jekyll serve --incremental`:Only regenerates changed files since the last build, making development faster and more efficient but does not render posts (i.e. FAQ, blog, news, and events).
Copy link
Contributor

@quozl quozl Nov 16, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Narrative is up against the command. Please break the line, as is the style now in use.

Your commit message could be simpler; e.g. Add Jekyll incremental vs full serve running docs.


Then open [http://localhost:4000](http://localhost:4000)
### Note
Expand Down