diff --git a/README.md b/README.md index 3450c9c..fbdf40d 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,38 @@ -A set of GitHub pages describing the status of various Qualcomm platforms. +# A set of GitHub pages describing the status of various Qualcomm platforms. -Testing it locally ------------------- +## Testing it locally - Install Ruby and bundler: -``` -sudo apt install bundler -``` + + ```bash + sudo apt install bundler + ``` - Setup bundler to use user path for all the storage: -``` -bundle config set --local path ~/.local/lib/ -``` + + ```bash + bundle config set --local path ~/.local/lib/ + ``` - Install all the dependencies: -``` -bundle install -``` + + ```bash + bundle install + ``` - Just rebuild the data: -``` -./regen.py -bundle exec jekyll build -``` -Now you can check the HTML data built in `./_site/`. + ``` + ./regen.py + bundle exec jekyll build + ``` + Now you can check the HTML data built in `./_site/`. - Or execute a local Jekyll server, providing an ongoing preview: -``` -bundle exec jekyll serve -``` -Now you can open [localhost:4000](http://127.0.0.1:4000/msm/) with your Web -browser. Jekyll will automatically regenerate the pages if any of the source -files changes. + + ```bash + bundle exec jekyll serve + ``` + + Now you can open [localhost:4000](http://127.0.0.1:4000/msm/) with your Web + browser. Jekyll will automatically regenerate the pages if any of the source + files changes.