Commit Graph

8 Commits

Author SHA1 Message Date
Martin Braun
c198cc923e Update CODING guidelines
- Reference clang-format
- Fix typos
2019-09-04 15:10:49 -07:00
Brent Stapleton
e3fd16a867 coding guidelines: change URLs to hyperlinks 2019-01-02 17:26:42 -08:00
Martin Braun
a69ab0c23a cmake: Update coding style to use lowercase commands
Also updates our coding style file.

Ancient CMake versions required upper-case commands.  Later command
names became case-insensitive.  Now the preferred style is lower-case.

Run the following shell code (with GNU compliant sed):

cmake --help-command-list | grep -v "cmake version" | while read c; do
  echo 's/\b'"$(echo $c | tr '[:lower:]' '[:upper:]')"'\(\s*\)(/'"$c"'\1(/g'
done > convert.sed \
&& git ls-files -z -- bootstrap '*.cmake' '*.cmake.in' \
'*CMakeLists.txt' | xargs -0 gsed -i -f convert.sed && rm convert.sed

(Make sure the backslashes don't get mangled!)
2018-11-14 14:10:09 -08:00
Martin Braun
1ab86305c1 coding guidelines: Add .at() vs [] comment 2018-11-13 10:42:27 -08:00
Martin Braun
f2896713d4 Update README.md, LICENSE.md, and CONTRIBUTING.md 2018-06-26 08:56:32 -07:00
Martin Braun
0adacaa252 docs: Update coding guidelines (C++ guidelines, git messages)
- Added reference to the C++ Core Guidelines
- Rephrased some of the git commit message guidelines and fixed a bad
  example (was not using imperative mood in the commit message)
2017-11-08 11:04:09 -08:00
Martin Braun
41998dc9c8 Add reference to FPGA coding guidelines 2017-10-19 16:39:45 -07:00
Martin Braun
edcb4ba036 Add coding guidelines
This adds coding guidelines for software (not FPGA).
2017-10-16 12:03:22 -07:00