Browse Source

Update readme

julien colomb 4 years ago
parent
commit
a22c32e235
1 changed files with 27 additions and 10 deletions
  1. 27 10
      README.md

+ 27 - 10
README.md

@@ -1,18 +1,35 @@
-# Template v.1.0
+# This repository is a home for your project, modify it the way you need it to be, start with this readme file!.
 
-New template, or additional information may be available at https://gin.g-node.org/larkumlab/Main_template. Please use that repositories issues to give feedback or ask questions about the template.
 
-This is a template for repositories of the larkum lab, all data and documents related to one project should find its place here.
 
-Note that the 
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed ullamcorper porttitor quam, quis tempus eros aliquam ut. Donec commodo magna nec neque laoreet ultricies. Nam molestie euismod tellus nec iaculis. Duis et sapien leo. Quisque nec posuere leo, non elementum felis. Nullam ultrices, ligula in eleifend tempus, quam ipsum volutpat metus, ultricies commodo ipsum purus eu eros. In a suscipit mi, sed tristique tellus. Aliquam aliquet, elit sed convallis tempor, libero felis aliquet nisl, in mattis ipsum purus vel ante. Proin placerat magna in tellus congue, eget feugiat nisi cursus. Praesent fermentum, nunc eu varius molestie, lectus risus convallis dui, hendrerit commodo tellus dolor nec ante. Fusce venenatis eros nulla, sit amet fermentum metus pulvinar a. Curabitur malesuada, velit at iaculis pretium, quam augue ornare risus, sed elementum turpis diam eu nibh.
+
+Aliquam eleifend sit amet urna et iaculis. Curabitur eget maximus nulla. Maecenas interdum augue non risus gravida posuere. Quisque bibendum magna sit amet massa ultricies tristique. Cras luctus est non gravida lobortis. Phasellus at pellentesque lectus. Sed facilisis volutpat magna non iaculis. Aliquam turpis nunc, feugiat nec mauris volutpat, tempus venenatis nisi. Mauris sit amet ullamcorper est. Vestibulum aliquet lobortis luctus. Ut felis felis, ultrices at lorem in, malesuada rhoncus mi. Quisque dignissim elementum auctor.
+
+Vestibulum nec augue in mauris tincidunt semper sed et eros. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Mauris finibus ante ac tempus vulputate. Etiam diam eros, sodales id urna eget, egestas tincidunt augue. Nunc consequat dui id nunc tincidunt tristique. Curabitur ultricies tortor sed quam pellentesque commodo. Fusce cursus sem sit amet sapien convallis, non volutpat nibh ullamcorper. 
+
+---
+
+
+
+This repository was created from the larkum lab template v.1.0. Access new template, or additional information at https://gin.g-node.org/larkumlab/Main_template. Please use that repositories issues to give feedback or ask questions about the template. 
+
+
+**All data and documents related to one project should find its place here. If any file related to the project is stored outside of this repository, please indicate links in this file.**
+
+Here are some additional information about this version of the template, you are welcome to erase it to facilitate reading.
+
+---
+
+**Template v.1.0:**
+
 
 - `10_rawdata` folder will be published upon publication, with or independently of the code folder.
-- `90_shared` folder is meant for any file you want to share with the rest of the lab.
-- If any file related to the project is stored outside of this repository, please indicate links here.
+- `90_sharedfolder` is meant for any file you want to share with the rest of the lab, so it is not shared outside the lab.
 
-# FAQ
+## FAQ
 
-## What are derived and raw data?
+### What are derived and raw data?
 
 
  In theory, data that can be derived from another dataset during the analysis is called derived data.In practice here, raw data is what will be stored long term, derived data will be trashed once the paper is published and we need the room. Because it becomes more costly to store the data (> 10 years) than to reproduce it, derived data are normally not stored. Note that if the derived data is small but the computing time to produce it is large (for example with video analysis producing a spreadsheet file), it is advised to put that dataset in the 10_rawdata folder.
@@ -21,14 +38,14 @@ Note that the
 
 
 
-## I am not using code ?
+### I am not using code ?
 
 
 
 please then describe your analysis using words. The point is that the analysis can be performed again, by somebody else than yourself. That information would be better suited in the `40_notebook` folder.
 
 
-## What is this author list below ?
+### What is this author list below ?
 
 This is a draft metadata to be used to publish datasets or software directly from GIN. It is created from the `datacite.yml` file, that you can modify.