testcode.git

README.md   1) # testcode
README.md   2) 
README.md   3) This is just a test project. You can do anything here, test g++, make, cmake,
README.md   4) git, cscope, and IDE projects.
README.md   5) 

README.md   6) ## Getting the project

README.md   7) 
README.md   8) You can get a copy of this project by clicking on the

README.md   9) [ZIP](https://git.dlma.com/testcode.git/zipball/main)
README.md  10) or [TAR](https://git.dlma.com/testcode.git/tarball/main) buttons

README.md  11) near the top right of the GitList web page.

README     12) 

README     13) You can clone from the origin with:
README     14) 

README.md  15)     git clone ssh://USERNAME@dlma.com/~/git/testcode.git

README     16) 

README.md  17) ## IDEs
README.md  18) 
README.md  19) ### tmux vim entr
README.md  20) 

README.md  21) Create two panes in tmux, run vim in one, and run entr in the other. You probably
README.md  22) only need the `git ls-files` for `entr`, but I provide a bash command group with
README.md  23) `find` here so I can easily copy and change it as needed.

README.md  24) 

README.md  25)     { git ls-files && find . -type f -regex '.*\.\(cfg\|local\)'; } | \

README.md  26)     entr -c sh -c 'ctags -R *; make -j$(nproc) && \
README.md  27)     valgrind -q --leak-check=yes --show-leak-kinds=all product/testcode'

README.md  28) 

README.md  29) `find` could also have been `find . -type f \( -name \*.cfg -or -name \*.local \)`.

README.md  30) 

README.md  31) To compile with debug info and run in gdb:

README.md  32) 

README.md  33)     ... | entr -c sh -c 'ctags -R *; make debug -j$(nproc) && gdb product/testcode'

README.md  34) 

README.md  35) Tip: In vim you can grep and use the QuickFix window with commands like...
README.md  36) 
README.md  37)     :grep -rI --exclude=tags --exclude=cscope.* --exclude-dir=obj searchterm .

README.md  38)     :cw
README.md  39) 

README.md  40) See [this QuickFix tip for sorting results by filename](https://git.dlma.com/dotfiles.git/commit/0cb566c53caf931c8b3f423dcfded4660b220cbb).

README.md  41) 

README.md  42) #### entr One-Liner for When no Makefile
README.md  43) 
README.md  44) [This entr command is handy](https://twitter.com/dblume/status/1421011043489255424) when composing interview questions without a Makefile:
README.md  45) 

README.md  46)     ls -1 *.h *.cpp | entr sh -c 'g++ -Wall -std=c++17 -pthread *.cpp && \
README.md  47)     valgrind -q --leak-check=yes --show-leak-kinds=all ./a.out'

README.md  48) 

README.md  49) ### Visual Studio Code and WSL2
README.md  50) 
README.md  51) Once you've got the [Remote -WSL extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl)
README.md  52) for WSL, you can invoke Code from the WSL side.
README.md  53) 
README.md  54)     code .
README.md  55) 
README.md  56) Or, if it's not in your path, something like...
README.md  57) 
README.md  58)     /mnt/c/Users/$USER/AppData/Local/Programs/Microsoft\ VS\ Code/bin/code .
README.md  59) 

README.md  60) ### Other IDEs
README.md  61) 
README.md  62) Look for the presence of their project files. They should work normally.

README.md  63) 

README.md  64) ## Formatting

README.md  65) 

README.md  66) Use clang-format. Install the distro's version with:

README.md  67) 
README.md  68)     sudo apt install clang-format
README.md  69) 

README.md  70) Or install a newer one (replace 17 with whatever's current now) with:
README.md  71) 
README.md  72)     wget https://apt.llvm.org/llvm.sh
README.md  73)     chmod +x llvm.sh
README.md  74)     sudo ./llvm.sh 17
README.md  75)     sudo apt install clang-format-17
README.md  76) 

README.md  77) Then, after making your edits, use the [vim integration](https://clang.llvm.org/docs/ClangFormat.html#vim-integration)
README.md  78) or manually format in one of a couple of ways:
README.md  79) 
README.md  80) ### Use git-clang-format
README.md  81) 
README.md  82) `git-clang-format` is installed with clang-format and will format staged files
README.md  83) into the unstaged area.
README.md  84) 
README.md  85) 1. Stage the files you want to format.

README.md  86) 2. Run `git-clang-format --binary=clang-format-17 --style=file`, and it'll leave unstaged formatting changes.

README.md  87) 3. Review with `git difftool` and accept the desired changes or unstage.
README.md  88) 
README.md  89) ### Manually clang-format

README.md  90) 
README.md  91)     git status --porcelain | \
README.md  92)     awk 'match($1, "M|A") && match($2, "(c|h)(pp)?$"){print $2}' | \

README.md  93)     xargs clang-format-17 -style=file -i

README.md  94) 
README.md  95) Or, shorter but less comprehensive:
README.md  96) 

README.md  97)     git ls-files -m | egrep ".(c|h)(pp)?$" | xargs clang-format-17 -style=file -i

README.md  98) 

README.md  99) ## Current Features

README    100) 
README    101) * Multiple directories for testing build systems and IDEs
README    102) * "make" essentially works.
README    103) 

README.md 104) ## Is it any good?

README.md 105) 
README.md 106) [Yes](https://news.ycombinator.com/item?id=3067434).
README.md 107) 

README.md 108) ## To Do

README    109) 
README    110) * Compare make vs. cmake vs. autotools

README    111) * Experiment with ctags generation