diff --git a/README.md b/README.md index 842dc72f..e377d8d2 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,28 @@ The current iteration uses Jekyll to produce pages. decal-web is built for [Jekyll](https://jekyllrb.com), a static site generator. View the [quick start guide](https://jekyllrb.com/docs/) for more information. +### Developing on Supernova + +This is the recommended method of development. + +1. SSH into supernova +```bash +$ ssh @supernova.ocf.berkeley.edu +``` +2. Clone this repository +```bash +$ git clone https://github.com/0xcf/decal-web +``` +3. Start the Jekyll server on supernova with: +```bash +$ cd decal-web +$ make supernova +``` + +The console should ouput a web address (`http://supernova.ocf.berkeley.edu:8xxx/`). This web-page will update as you make changes, reload your browser tab to preview the changes. + +### Developing on your local machine + You will need Ruby 2 to build the site (it has been tested on Ruby2.7.4). * On Ubuntu 20.04, Ruby can be installed using `sudo apt install ruby-full`. * If using Arch, [follow this guide](https://gist.github.com/jhass/8839655bb038e829fba1) to install it. @@ -21,11 +43,11 @@ You may also need to install Bundler 2.2.25: `gem install bundler:2.2.25` ```bash $ bundle install ``` -1. Start your local Jekyll server. You can also use `make local-dev`. +2. Start your local Jekyll server. You can also use `make local-dev`. ```bash $ bundle exec jekyll serve ``` -1. The console should output a server address (`localhost:8xxx`). Open that address in your browser. -1. Reload your web browser after making a change to preview its effect. +3. The console should output a server address (`localhost:8xxx`). Open that address in your browser. +4. Reload your web browser after making a change to preview its effect. For more information, refer to [Just the Docs](https://pmarsceill.github.io/just-the-docs/).