parbhat/cs-club-site-at-sjsu

The source of the website for the CS Club @ SJSU

CS Club @ SJSU Web site

The open-source repository for http://csclubsjsu.com/, San Jose State University's Computer Science club.

The github page for this project can be found at https://github.com/CS-Club-at-SJSU/CS-Club-Site-at-SJSU.

About this project

The site is implemented as a Jekyll project. It uses markdown, primarily, to format its pages. The project is still in its infancy and we have not yet identified all of the technologies we wish to use, nor all the functionality we wish to implement.

How to test the site

Testing the site in a local deployment (not meant for production release) is very simple, almost suspiciously so.

Follow these very simply instructions (link) to install jekyll. (Summary: on most machines, just sudo gem install jekyll.) Then, in the root project directory, run:

$ jekyll --serve

Then point your browser at http://localhost:4000. It should be running!

How to contribute

To contribute a change, please fork the project and hack way! When you've finished comitting your changes, send a 'Pull Request' through github, and the webmaster will review and merge your changes.

Adding a new page

In short, to add a new page, you can either just add a file (like 'about.md'), or you could also run rake page name='NAME HERE'. Your call.

Adding a new post

Just run rake post title='TITLE HERE'. This will create a new file in the _posts directory that you can modify as you need. For consistency, the first few lines of the file should be edited to look like the following:

---
layout: post
title: "Full Title Here"
tagline: "This can be skipped - your choice"
tags: [classes]
author: Sammy S.
authoremail: [email protected]
---
{% include JB/setup %}

Note that every field is optional except "layout", "title", and the final line with the include directive. The tags don't do anything currently but feel free to tag them as we might use tags later on.

About the author

The original project was created by student Erich Blume < [email protected] > in 2012. Erich claims the copyright, but has licensed the project under the GPLv3 (see below) so that future generations of SJSU hackers can use it as they see fit.

About the oldest-ancestor repo

You might have noticed that user 'eblume' holds the oldest repo, despite the fact that the 'canonical' repo is a descendent. This is an artifact of how the project developed. Please do use the official CSC@SJSU repo, and not the oldest-ancestor repo (owned by eblume).

License

This project is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This project is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this project. If not, see http://www.gnu.org/licenses/.