From 3a1489f28bfd65249babf031d9d893b6986f12ab Mon Sep 17 00:00:00 2001 From: Daniel Thoren Date: Wed, 21 Apr 2021 10:18:50 +0200 Subject: [PATCH] Update README.md --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 98454a7..657de6e 100644 --- a/README.md +++ b/README.md @@ -100,6 +100,19 @@ Context: [coverage-badge]: https://img.shields.io/badge/Coverage-100%25-brightgreen.svg +## Documentation +* Use markdown with [Google Style Guide](https://google.github.io/styleguide/docguide/style.html) for written documentation. +* Conceptual graphical documentation as inline embedded images. +* Save Matplotlib / Seaborn plots as `.svg`. +* Sketches and handwritten illustrations scanned / photographed as `.png`/`.jpg`. +* Scanned / photographed illustrations should be cropped, contrast and alligned. + +|Cons of tables |Pros of tables| +|--|--| +| Great splitting information | Painful to format in MD| + + + ## Other methdology * [Things you should do now](https://secure.phabricator.com/book/phabflavor/article/things_you_should_do_now/) * Follow [naming conventions](https://visualgit.readthedocs.io/en/latest/pages/naming_convention.html)