Skip to content

Latest commit

 

History

History
74 lines (56 loc) · 3.35 KB

README.md

File metadata and controls

74 lines (56 loc) · 3.35 KB
Raw

REPOSITORY MOVED

ACHTUNG! We no longer use GitHub. This is an outdated version of the site, and any commits/pulls/issues created here will be ignored. Please visit the new repository:

https://gitlab.com/cyberatuc/cyberatuc.org

cyberatuc.org

New Cyber@UC website built using Jekyll.

Installation

You should be able to build and run this site on any OS (though I have not tested with Windows—you'll want to see this guide).

Dependencies

You need to install these before you try to install the site itself:

  • Ruby (version 2.x) (instructions)
  • Rubygems (This usually comes with Ruby, so check if the gem command already exists. If it doesn't, use these instructions.)
  • Bundler (gem install bundler)
  • ImageMagick (Your package manager probably has it as either imagemagick or ImageMagick, or else get it from their website.)

Here's an easy install script for macOS (assuming you already have Homebrew):

brew install ruby imagemagick
gem install bundler

Building and testing

Once you've got all that installed, just clone the repository and run the install command for dependencies:

git clone https://github.com/UCyber/cyberatuc.org.git
cd cyberatuc.org
bundle install

To run a web server for local testing, do: bundle exec jekyll serve. When the web server is running, the site available at http://localhost:4000/. The web server will automatically rebuild any pages you modify, so you don't need to restart the server all the time—just save your edits and refresh. (N.B. Changes to _config.yml do require a server restart.)

If you just want to build the site without running a test server, do: bundle exec jekyll build. This will generate all necessary site pages in the _site/ directory.

For reference, here is the script I use to rebuild the site on my web server every time I commit a new update:

#!/usr/bin/env bash
export JEKYLL_ENV=production
cd cyberatuc.org/
git pull
bundle install
jekyll build

Contributing

You can find information about how to edit this site at cyberatuc.org/guides/website.

License

MIT License

Copyright (c) 2018 Hayden Schiff

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.