Skip to content

Commit

Permalink
Update README with theme preview, Github pages URL and a note about f…
Browse files Browse the repository at this point in the history
…onts.com.
  • Loading branch information
adamjohnson committed May 31, 2018
1 parent 493a18f commit 4dccf15
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
catalog-static
==================

![Preview of the Course Catalog Template](https://raw.githubusercontent.com/wvuweb/catalog-static/master/images/catalog-html-template-preview.jpg)

**Theme description:** A WVU branded template for Catalog.wvu.edu made with vanilla HTML. This template could be easily adapted to apply WVU's brand to other applications.

**Developers name(s):** Adam Johnson

**Github repository URL:** [https://github.com/wvuweb/catalog-static](https://github.com/wvuweb/catalog-static)

**Site URL:** Production: [https://catalog.wvu.edu](https://catalog.wvu.edu)
**Site URL:** Production: [https://catalog.wvu.edu](https://catalog.wvu.edu). Development: [https://wvuweb.github.io/catalog-static/](https://wvuweb.github.io/catalog-static/)

**Dependencies:** [NodeJS](https://nodejs.org/en/), [Gulp](http://gulpjs.org), all of it's dependencies and Node packages.

Expand Down Expand Up @@ -51,6 +53,10 @@ This is a flat HTML template which uses styles from WVU's pattern library, [Supe

This theme uses [Sass](http://sass-lang.com/) and Gulp to compile the CSS. I have specifically commented out various partials in `scss/1-base/base-dir.scss` and `scss/2-modules/modules-dir.scss` because Catalog didn't use those patterns (performance!). If you want to use some of the commented out patterns (maybe you need two, three or four column stuff), follow the install instructions, run `gulp` and uncomment the requisite Sass partials.

### Fonts.com

This theme uses Helvetica Neue from fonts.com. We've whitelisted fonts.com to `*.wvu.edu` and local domains. As a result, the fonts will 404 if you preview them here on Github pages. To see the fonts in all their glory, clone the project and run Gulp.

## Have questions?

If you have questions or need help, please [contact Adam Johnson](https://universityrelations.wvu.edu/digital-services#staff) or any WVU University Relations team member. Don't be afraid to open an issue if it's related to this project.
Expand Down

0 comments on commit 4dccf15

Please sign in to comment.