Skip to content
This repository has been archived by the owner on Feb 1, 2018. It is now read-only.

Commit

Permalink
Added image and contributing section
Browse files Browse the repository at this point in the history
This commit is based on some of the things learnt in the campus-experts technical writing workshop. An image has been added to make the readme more visual, the description provides context for the repo and there has been a contributing guideline added. Build and test instructions we're simple and straightforward enough i believe so they remained the same
  • Loading branch information
PandelisZ committed Apr 27, 2017
1 parent 57022cf commit 9f0feff
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions communities/hacs/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
[![Build Status](https://travis-ci.org/HaCSBCU/hacsbcu.github.io.svg?branch=master)](https://travis-ci.org/HaCSBCU/hacsbcu.github.io)

![Website Screenshot](http://i.imgur.com/lJnqm1B.jpg)

# HaCS
This is the website for HaCS - Hackathon and Computing Society at Birmingham City University. This website acts as our central resource for content and as a playground for our members to try out new ideas and work together with others.

We're open to contributions and are always improving our site. If there are any suggestions you might have or something you'd like to work on yourself feel free to open an [issue](https://github.com/HaCSBCU/hacsbcu.github.io/issues/new).

If you are a BCU student and would like to contribute to this site but don't know how yet, it might be a good idea to drop us a message on our [Facebook group](https://www.facebook.com/groups/hacsbcu/) or drop into one of our workshops.


## Building

We're using jekyll to build the site. If you want to test locally you will need [ruby](https://rvm.io/rvm/install) and [jekyll](https://jekyllrb.com/) to be installed.

Once you have ruby installed:

`$ gem install bundler`

To run the jekyll build (inside this directory):

`$ bundle exec jekyll serve`

## Testing

To run the test scripts you can run `./tests/htmlproofer`

make sure that htmlproofer is executable `chmod +x ./test/htmlproofer`

## Contributing

This project is targeted to members of HaCS or BCU students. You are welcome to contribute issues or feature suggestions however we would prefer HaCS members take on building and implementing said features.

As this project aims to be beginner friendly, please keep a friendly, open and collaborative attitude when communicating on this repository, and be respectful of everyone's abilities and ideas.

For a full code of conduct consult our [conduct](https://github.com/hacsbcu/conduct) repository

0 comments on commit 9f0feff

Please sign in to comment.