diff --git a/README.md b/README.md index 5cd7b31..6922d82 100644 --- a/README.md +++ b/README.md @@ -68,10 +68,8 @@ git log --all --decorate --oneline --graph # when you have uncommitted changes git add --patch -``` -#### New Development Flow -``` +# NEW DEVELOPMENT FLOW # clone repo with local_name enables several clones git clone @@ -83,10 +81,8 @@ git checkout git checkout git branch git push --set-upstream origin -``` -#### Comparing / Merging two branches -``` +# Comparing / Merging two branches git merge --no-commit --no-ff ``` @@ -107,38 +103,30 @@ Context: # -> feature1 is rejected and made obsolete ``` -## Repo Badges -> Coming soon! 🚧 - -![Coverage badge][coverage-badge] - -[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| - -## Python +# Python Python is notoriously painful to manage. Use [pipx](https://pypi.org/project/pipx/) or [pyenv](https://mitelman.engineering/blog/python-best-practice/automating-python-best-practices-for-a-new-project/). ### Pathlib +For navigating, reading and filesystem and file read/write. ``` from pathlib import Path Path('.').iterdir() Path('.').absolute() ``` -## Deploying to Servers +### Deploying to Servers When deploying to FreeBSD and Linux servers, place the code in the `/home` directory. +# 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. + + + ## Other methdology * Closed Source Software: If you cannot check what it does / how it works, do not use it for the sake of security. * [Things you should do now](https://secure.phabricator.com/book/phabflavor/article/things_you_should_do_now/) @@ -175,5 +163,15 @@ When deploying to FreeBSD and Linux servers, place the code in the `/home` direc * [open source cousin to GPL3](https://github.com/kingoflolz/mesh-transformer-jax) * [Divide year into 26 fortnights labelled A-Z](https://futureofcoding.org/episodes/044#19) -# Project Portfolio +# Sort Sections + +### Repo Badges +> Coming soon! 🚧 + +![Coverage badge][coverage-badge] + +[coverage-badge]: https://img.shields.io/badge/Coverage-100%25-brightgreen.svg + + +### Project Portfolio * Consumption Predictor