enh: Windows experience
Description
On Windows platform, the installation procedure is not complete, i.e. how to install the requirements and how to launch easily sheldon from Windows console.
Several bugs:
-
This exception is thrown when the character 'è' is encountered in a source file for exemple :
* @param _stepèlength first and maximum step length. * @param _step_length first and maximum step length.
Functional specifications
No functional modifications
Technical specifications
- Modification of the sight-git/README.md file to explain how to install requirements on windows.
- Adding a sheldon.bat in sight-git/hooks (side by side to the python startup file used by sheldon).
- Bug 1 (invalid escape sequence '\o'): just use a python raw string.
- Bug 2: Resolve by catching the UnicodeDecodeError exception, report the error (type and location) and continue the analysis.
- Add documentation on how to invoke sheldon in a git hook (see gitlab rules 6.1.1. commit-msg hook)
Test plan
Applying sheldon using my computer on sight#1218 (closed)