Merge branch 'master' of https://bitbucket.org/mjsb/perguntations

Miguel Barao
2 parents a54bd1fd c6680e1b
Showing 1 changed file with 42 additions and 0 deletions Show diff stats
README.md
@@ -0,0 +1,42 @@
+# README #
+
+Online "perguntations".
+
+### Requirements:
+
+- python3.4
+- cherrypy
+- mako
+- yaml
+
+
+### System setup:
+
+
+```
+#!bash
+
+# create database in the directory db/
+initdb_from_csv.py siiue.csv
+mkdir db
+mv students.db db
+
+# update test configuration
+vi demo/test.yaml                # update students_db
+mkdir logs                       # logs are stored here
+
+# run demo test
+./serve demo/test.yaml
+
+```
+
+### Contribute ###
+
+* Writing questions in yaml format
+* Testing and reporting bugs
+* Code review
+* New features and ideas
+
+### Contacts ###
+
+* Miguel Barão mjsb@di.uevora.pt
 \ No newline at end of file
	@@ -0,0 +1,42 @@		@@ -0,0 +1,42 @@
		1	+# README #
		2	+
		3	+Online "perguntations".
		4	+
		5	+### Requirements:
		6	+
		7	+- python3.4
		8	+- cherrypy
		9	+- mako
		10	+- yaml
		11	+
		12	+
		13	+### System setup:
		14	+
		15	+
		16	+```
		17	+#!bash
		18	+
		19	+# create database in the directory db/
		20	+initdb_from_csv.py siiue.csv
		21	+mkdir db
		22	+mv students.db db
		23	+
		24	+# update test configuration
		25	+vi demo/test.yaml # update students_db
		26	+mkdir logs # logs are stored here
		27	+
		28	+# run demo test
		29	+./serve demo/test.yaml
		30	+
		31	+```
		32	+
		33	+### Contribute ###
		34	+
		35	+* Writing questions in yaml format
		36	+* Testing and reporting bugs
		37	+* Code review
		38	+* New features and ideas
		39	+
		40	+### Contacts ###
		41	+
		42	+* Miguel Barão mjsb@di.uevora.pt
0	\ No newline at end of file	43	\ No newline at end of file