Ans commited on
Commit
2f52881
0 Parent(s):

first commit

Browse files
Files changed (1) hide show
  1. README.md +27 -0
README.md ADDED
@@ -0,0 +1,27 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Guidance
2
+ This is a suggested template for a project. You can modify it as you please, but
3
+ but remember to keep:
4
+
5
+ * a timelog, updated regularly in the `timelog.md` format;
6
+ * all source under version control;
7
+ * data well organised and with appropriate ethical approval (for human subject data);
8
+
9
+ Here's an overview of the structure as it stands:
10
+
11
+ * `timelog.md` The time log for your project.
12
+ * `plan.md` A skeleton week-by-week plan for the project.
13
+ * `data/` data you acquire during the project
14
+ * `src/` source code for your project
15
+ * `status_report/` the status report submitted in December
16
+ * `meetings/` Records of the meetings you have during the project.
17
+ * `dissertation/` source and for your project dissertation
18
+ * `presentation/` your presentation
19
+
20
+ * Make sure you add a `.gitignore` or similar for your VCS for the tools you are using!
21
+ * Add any appropriate continuous integration (e.g. Travis CI) in this directory.
22
+
23
+ * Remove this `readme.md` file from any repository and replace it with something more appropriate!
24
+
25
+ ## Important
26
+ * It should be easy to rebuild and run your project and your dissertation
27
+ * Include clear instructions in the relevant directories to make this possible