Commit 22a709de authored by Daniel W Bond's avatar Daniel W Bond

added template readme for project

parent 4fde666d
# SCHEDULES
SRCT Schedules creates calendar files based on student course schedules and more.
## On Contributing
Schedules 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.
There are many things that can be done with this project (see the project's [milestones](https://git.gmu.edu/srct/schedules/milestones) and [issues](https://git.gmu.edu/srct/schedules/issues) pages on [git.gmu.edu](https://git.gmu.edu/)), but sometimes it's the small things that count, so don't be afraid of contributing just a small spelling mistake.
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.
The project manager for this project is [David Stein](dstein3@gmu.edu).
Please visit the [SRCT homepage](https://srct.gmu.edu/) and [SRCT Wiki](http://wiki.srct.gmu.edu/) for more information about SRT and its initiatives, along with other helpful links and tutorials.
## Setting everything up for development
These instructions are for Ubuntu and Debian, or related Linux distributions. (If you'd like to help write the instructions for Mac's OSX, please do!)
### Prerequisities
### Package Installation
### Copying Down the Source Code
Now, we're going to copy down a copy of the Schedules codebase from git.gmu.edu, the SRCT code respository.
Configure your ssh keys by following the directions at git.gmu.edu/help/ssh/README.
Now, on your computer, navigate to the directory in which you want to download the project (perhaps one called development/ or something similar), and run
`git clone git@git.gmu.edu:srct/schedules.git`
## Starting up the test server
## Deployment
### Docker
For server deployment, not for most local work
## About Mason 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.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment