cycat-project-website/README.md

42 lines
991 B
Markdown
Raw Normal View History

2021-01-30 20:38:57 +01:00
# CyCAT.org website
2020-08-27 08:23:31 +02:00
2020-01-17 08:33:39 +01:00
# Installation
2018-12-10 01:18:14 +01:00
2020-08-23 12:44:27 +02:00
### Installing Ruby & Jekyll
2021-01-30 20:38:57 +01:00
2020-08-23 05:57:25 +02:00
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.
2018-12-10 01:18:14 +01:00
2021-01-30 20:38:57 +01:00
### Installing website
2020-08-23 05:57:25 +02:00
2021-01-30 20:38:57 +01:00
Download or clone the website.
2020-08-23 05:57:25 +02:00
2020-08-23 12:44:27 +02:00
To run the theme locally, navigate to the theme directory and run:
2020-08-23 05:57:25 +02:00
2020-08-23 12:44:27 +02:00
```
bundle install
2021-01-30 20:38:57 +01:00
```
2020-01-17 08:17:19 +01:00
2020-08-23 12:44:27 +02:00
To start the Jekyll local development server.
2020-01-17 08:17:19 +01:00
2020-08-23 12:44:27 +02:00
```
bundle exec jekyll serve
2021-01-30 20:38:57 +01:00
```
2020-08-23 12:44:27 +02:00
To build the theme.
2021-01-30 20:38:57 +01:00
2020-08-23 12:44:27 +02:00
```
bundle exec jekyll build
```
2021-01-30 20:38:57 +01:00
### Deployment
2020-08-23 12:44:27 +02:00
2021-02-01 09:44:57 +01:00
- Run `./build.sh`
2020-08-27 08:23:31 +02:00
2021-01-30 20:38:57 +01:00
## License
2020-08-23 12:44:27 +02:00
2021-01-30 20:38:57 +01:00
The website is based on [Jekyll-serif](https://jekyll-serif.netlify.app/)).
2020-08-23 12:44:27 +02:00
2021-01-30 20:38:57 +01:00
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!
2020-08-23 12:44:27 +02:00