Commit ca00949e authored by Daniel W Bond's avatar Daniel W Bond
Browse files

readme revamped

parent 7c580b87
...@@ -6,13 +6,13 @@ Our own little site on the world wide web ...@@ -6,13 +6,13 @@ Our own little site on the world wide web
On Contributing On Contributing
--- ---
PROJECT NAME 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. SRCTweb 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 "To Do" section), but sometimes it's the small things that count, so don't be afraid of contributing just a small spelling mistake. 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.
If you need help at all please contact and SRCT member. We want people to contribute, so if you are struggling, or just want to learn we are more than willing to help. If you need help at all please contact and 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 lead for this project is **PERSON**. *PERSON'S EMAIL ADDRESS* The project lead for this project is **Daniel Bond**. *dbond2@gmu.edu*
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. 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.
...@@ -21,20 +21,32 @@ Setup ...@@ -21,20 +21,32 @@ Setup
To get started, you'll need the following installed: To get started, you'll need the following installed:
* [Git](http://git-scm.com/book/en/Getting-Started-Installing-Git) * [Git](http://git-scm.com/book/en/Getting-Started-Installing-Git)
* Language(s) * Python
* 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. 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`` ``bash``
``git clone git@git.gmu.edu:srct/PROJECT.git`` ``git clone git@git.gmu.edu:srct/srctweb.git``
``cd PROJECT/`` ``cd srctweb/``
``A Django project, for example, would include setting up virtual environment, installing from requirements file, setting up south, syncing the database, and runserver`` ``pip install -r requirements.txt``
``cd srctweb/``
``python run.py``
To-do To-do
--- ---
Note-- this should also be on the wiki Note-- this should also be on the wiki
* A footer
* Links *everywhere*
* Consistent color scheming-- bring in some greens and golds
* The meeting page needs to have forms for the secretary to take notes, and pagination
* RSS feed for the meeting page
* Set up the documents with actual files
* Write Usage Policy
* Figure out intellectual property with GMU
* Some sort of a calendar plugin for the calendar page
* Add stuff to the events page-- same idea as meeting page, forms, pagination, and RSS
* Have js follow the librejs tagging rules
About GMU SRCT About GMU SRCT
--- ---
......
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