@@ -109,23 +109,23 @@ configuring your development environment.
109109Note: The apt versions are too old on Trusty so follow the [ Linux - Build and Install from Source] ( #buildFromSource ) instructions
110110
111111##### Windows - WSL
112- Tested with Ubuntu 18. 04 LTS and 19.04
112+ Tested with Ubuntu 18- 04 LTS and 19.04
113113```
114- $ apt-get install astyle
115- $ git clone https://github.com/danmar/cppcheck.git
116- $ cd cppcheck/
117- $ git checkout 2.1 # or later version if available
118- $ mkdir build && cd build && cmake .. && cmake --build .
119- $ sudo make MATCHCOMPILER=yes FILESDIR=/usr/share/cppcheck HAVE_RULES=yes CXXFLAGS="-O2 -DNDEBUG -Wall -Wno-sign-compare -Wno-unused-function" install
114+ apt-get install astyle
115+ git clone https://github.com/danmar/cppcheck.git
116+ cd cppcheck/
117+ git checkout 2.1 # or later version if available
118+ mkdir build && cd build && cmake .. && cmake --build .
119+ sudo make MATCHCOMPILER=yes FILESDIR=/usr/share/cppcheck HAVE_RULES=yes CXXFLAGS="-O2 -DNDEBUG -Wall -Wno-sign-compare -Wno-unused-function" install
120120```
121121
122122##### Windows - GitHub Git Shell
123123
124124###### * IMPORTANT: Be sure to launch PowerShell As Administrator*
125125
126+ ```
126127### Install AStyle
127128
128- ```
129129# Download
130130iwr 'https://netix.dl.sourceforge.net/project/astyle/astyle/astyle%203.1/AStyle_3.1_windows.zip' -UserAgent [Microsoft.PowerShell.Commands.PSUserAgent]::FireFox -OutFile astyle.3.1.zip
131131
@@ -136,59 +136,44 @@ mv .\astyle.3.1.zip\AStyle 'C:\Program Files\AStyle'
136136# Add AStyle to your path
137137[Environment]::SetEnvironmentVariable("Path", $env:Path + ";C:\Program Files\AStyle\bin")
138138[Environment]::SetEnvironmentVariable("Path", $env:Path + ";C:\Program Files\AStyle\bin", [EnvironmentVariableTarget]::Machine)
139- ```
140139
141140### Install Cppcheck x64
142141
143- ```
144142# 64-bit
145143iwr 'https://github.com/danmar/cppcheck/releases/download/2.1/cppcheck-2.1-x64-Setup.msi' -UserAgent [Microsoft.PowerShell.Commands.PSUserAgent]::FireFox -OutFile cppcheck-2.1-x64-Setup.msi
146144
147145# Launch installer to install Cppcheck
148146& .\cppcheck-2.1-x64-Setup.msi
149147
150- # Add Cppcheck to your path
148+ ### Add Cppcheck to your path
151149[Environment]::SetEnvironmentVariable("Path", $env:Path + ";C:\Program Files\Cppcheck", [EnvironmentVariableTarget]::Machine)
152- ```
153150
154151### At this point you need to reboot for the path changes to take effect
152+ ```
155153
156154##### Windows - Cygwin
157-
158- Run either ` Cygwin Setup-x86-64.exe ` or ` Setup-x86.exe ` depending upon your OS. Select and install ` astyle ` and ` cppcheck ` .
155+ ```
156+ Run Either Cygwin Setup-x86-64.exe or Setup-x86.exe depending upon your OS. Select and install astyle and cppcheck
157+ ```
159158
160159##### <a name =" buildFromSource " ></a >Linux - Build and Install from Source
161160
161+ ```
162162### Install AStyle
163163
164- ```
165- $ # Download
166- $ curl -L 'https://sourceforge.net/projects/astyle/files/astyle/astyle%202.05.1/astyle_2.05.1_linux.tar.gz/download' | tar xvz
164+ # Download
165+ curl -L 'https://sourceforge.net/projects/astyle/files/astyle/astyle%202.05.1/astyle_2.05.1_linux.tar.gz/download' | tar xvz
167166
168- $ # Compile and install
169- $ cd astyle/build/gcc && sudo make shared release shared static install
170- ```
167+ # Compile and install
168+ cd astyle/build/gcc && sudo make shared release shared static install
171169
172170### Install Cppcheck
173171```
174- $ git clone https://github.com/danmar/cppcheck.git
175- $ cd cppcheck/
176- $ git checkout 2.1 # or later version if available)
177- $ mkdir build && cd build && cmake .. && cmake --build .
178- $ sudo make MATCHCOMPILER=yes FILESDIR=/usr/share/cppcheck HAVE_RULES=yes CXXFLAGS="-O2 -DNDEBUG -Wall -Wno-sign-compare -Wno-unused-function" install
179- ```
180-
181- ### Documentation
182-
183- To generate the user documentation an optional set of tools is necessary.
184-
185- * doxygen
186- * plantuml
187- * java (for plantuml)
188-
189- Call the doxygen helper from the project-root folder to create the documentation.
190- ```
191- $ ./Documentation/doxygen.sh
172+ git clone https://github.com/danmar/cppcheck.git
173+ cd cppcheck/
174+ git checkout 2.1 # or later version if available)
175+ mkdir build && cd build && cmake .. && cmake --build .
176+ sudo make MATCHCOMPILER=yes FILESDIR=/usr/share/cppcheck HAVE_RULES=yes CXXFLAGS="-O2 -DNDEBUG -Wall -Wno-sign-compare -Wno-unused-function" install
192177```
193178
194179### Implementation Details
@@ -225,12 +210,12 @@ intra-repo tool settings/configuration conflicts.
225210During the bootstrap process, certain keys and aliases are defined
226211that the runtime leverages.
227212
228- ##### git config keys
213+ #####git config keys
229214
230215* mysensors.toolsdir = .mystools (defined as a repo-relative path - location agnostic)
231216* mysensors.bootstrap-cksum = \<git sha of bootstrap-dev.sh used to detect an outdated environment>
232217
233- ##### git aliases
218+ #####git aliases
234219
235220* mystoolspath = *returns the absolute path to the tools dir*
236221* \<bundle name> = *(e.g. cppcheck) runs the tool bundle*
0 commit comments