README.md 1.79 KB
Newer Older
Daniel W Bond's avatar
Daniel W Bond committed
1
2
3
4
5
6
7
8
PROJECT NAME
===

Project Description

On Contributing
---

Jason D Yeomans's avatar
Jason D Yeomans committed
9
RoomList welcomes all the help it can get. Even if you don't feel like you can be helpful the more technical aspects, we definitely need designers, technical writers, and testers.
Daniel W Bond's avatar
Daniel W Bond committed
10
11
12

There are many things that can be done with this project (see the "To Do" section), but sometimes it's the small things that count, so don't be afraid of contributing just a small spelling mistake.

Jason D Yeomans's avatar
Jason D Yeomans committed
13
If you need help at all please contact a SRCT member. We want people to contribute, so if you are struggling, or just want to learn we are more than willing to help.
Daniel W Bond's avatar
Daniel W Bond committed
14
15
16
17
18
19
20
21
22
23

The project lead for this project is **PERSON**. *PERSON'S EMAIL ADDRESS*

Please visit the [SRCT Wiki](http://wiki.srct.gmu.edu/) for more information on this and other SRCT projects, along with other helpful links and tutorials.

Setup
---

To get started, you'll need the following installed:
* [Git](http://git-scm.com/book/en/Getting-Started-Installing-Git)
Jason D Yeomans's avatar
Jason D Yeomans committed
24
25
26
27
* Python
* Django 1.7
* Postgres
* Psycopg2
Daniel W Bond's avatar
Daniel W Bond committed
28
29
30
31
32
* Other language or framework-specific items

Open a terminal window and type in the following commands. (If you're on Windows, use [Cygwin](http://www.cygwin.com/). This will create a local, workable copy of the project.

``bash``
Jason D Yeomans's avatar
Jason D Yeomans committed
33
34
``git clone git@git.gmu.edu:srct/roomlist.git``
``cd roomlist/``
Daniel W Bond's avatar
Daniel W Bond committed
35
36
37
38
39
40
41
42
43
44
45
``A Django project, for example, would include setting up virtual environment, installing from requirements file, setting up south, syncing the database, and runserver``

To-do
---

Note-- this should also be on the wiki

About GMU SRCT
---

**S**tudent - **R**un **C**omputing and **T**echnology (*SRCT*, pronounced "circuit") is a student organization at George Mason University which enhances student computing at Mason. SRCT establishes and maintains systems which provide specific services for Mason's community.