From 09bc97b94c7aafd9a5a1861a734dacaa71f21f12 Mon Sep 17 00:00:00 2001
From: GATEAU Thibault <thibault.gateau@isae.fr>
Date: Wed, 26 Apr 2023 13:45:25 +0000
Subject: [PATCH] Update readme.md
---
readme.md | 30 ++++++++++++++----------------
1 file changed, 14 insertions(+), 16 deletions(-)
diff --git a/readme.md b/readme.md
index 3fa711c..7d98a9c 100644
--- a/readme.md
+++ b/readme.md
@@ -11,6 +11,7 @@ This set of steps and tools are highly recommended for working with a consistent
(Click on DESK Ticket.)
2 - tell me when it's done
+
3 - Check Access to your account (provided by your tutor)
4 - Rocket Chat account [there](https://rocketchat.isae.fr) - send me a 'hello'
@@ -24,15 +25,16 @@ This set of steps and tools are highly recommended for working with a consistent
6 - your gitlab project
- - write a reamde.md, MarkDown format containing at least :
+
+ - write a reamde.md, [MarkDown format](https://www.markdownguide.org/basic-syntax/) containing at least :
- * structure of your repo
- * quickstart guide (to lauch our wwork)
- * depenedncies (including conda env management)
- * install process of your developments.
+ * the structure of your repo
+ * a quickstart guide (to lauch our work)
+ * dependencies (including conda env management)
+ * thethe full install process of your developments.
- - a src/ will contain your code
- - a doc/ will contain your report, biblio etc. (and include the papers you have found) -
+ - a src/ folder will contain your code
+ - a doc/ folder will contain your report, biblio etc. (and include the papers you have found)
- good practices :
* do not push binary files (exception on .pdf for your report to open it fast, images & cie for easy compilation). For large binary files (e.g. viedos) see below
@@ -41,7 +43,7 @@ This set of steps and tools are highly recommended for working with a consistent
* use latex for your reports (you can use overleaf, but be shure to push src + pdf on your gitlab too)
* put large binaries files on the gitlab package. Tutorial at the end of this readme.
-6 - if you are using python, use conda envrionment
+7 - if you are using python, use conda envrionment
e.g. :
```
conda create -n my_env -c anaconda python=3.9.7
@@ -57,19 +59,15 @@ conda activate my_env
```
-7 - images and report
+8 - images and report
use vectorial imaging (pdf) and provide sources (dot, svg, odt, ppt...)
-8 - readme.md
- * short description
- * user quickstart guide
- * developer guide, with full framework install process (inlcuding dependencies)
-
+9 - for your report, use latex,
-9 - latex, overleaf
-overleaf.com/learn/latex/Bibliography_management_with_bibtex
+ex: [overleaf](overleaf.com/learn/latex/Bibliography_management_with_bibtex )
+10 - by default, all in english
# package registry, putting heavy files on gitlab:
--
GitLab