cycat-project-website/README.md

42 lines
991 B
Markdown
Executable File

# CyCAT.org website
# Installation
### Installing Ruby & Jekyll
If this is your first time using Jekyll, please follow the [Jekyll docs](https://jekyllrb.com/docs/installation/) and make sure your local environment (including Ruby) is setup correctly.
### Installing website
Download or clone the website.
To run the theme locally, navigate to the theme directory and run:
```
bundle install
```
To start the Jekyll local development server.
```
bundle exec jekyll serve
```
To build the theme.
```
bundle exec jekyll build
```
### Deployment
- Run `./build.sh`
## License
The website is based on [Jekyll-serif](https://jekyll-serif.netlify.app/)).
This theme is open source under the MIT license. If you fork or copy this theme you must leave me as the original author in the LICENSE file (on line 3 where I am listed as the author). Really, I just don't want people copying this theme and then saying it's their theme, because I put a lot of work into my themes, thanks!