diff --git a/readme.md b/readme.md index 05304a6aad261825baa11f63af744b9bf3b9d828..be255717255467da18ffec2179231c7142283b97 100644 --- a/readme.md +++ b/readme.md @@ -36,13 +36,9 @@ This set of steps and tools are highly recommended for working with a consistent - 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 - * use english - * at least 1 commit + push a day. But as many as you want. Use explicit messages with a "tag" in brackets for your commit messages (e.g: "[dev] implementing awesome feature showing that P = NP ") - * 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 [here](https://gitlab.isae-supaero.fr/hy7one/gitlabadmin/process) 6 - if you are using python, use conda envrionment @@ -65,7 +61,8 @@ conda activate my_env use vectorial imaging (pdf) and provide sources (dot, svg, odt, ppt...) 8 - readme.md - * short descirption + + * short description * user quickstart guide * developer guide, with full framework install process (inlcuding dependencies)