Explorar el Código

Updated readme. Clearer notes on branches.

Steve Thielemann hace 4 años
padre
commit
8975335369
Se han modificado 1 ficheros con 44 adiciones y 14 borrados
  1. 44 14
      README.md

+ 44 - 14
README.md

@@ -1,30 +1,60 @@
 
-# To Use:
+<strike># To Use:</strike>
 
-# git submodule update --init
-# Do this instead.  Avoid the submodule hell.
+<strike># git submodule update --init</strike>
+# Do this instead.  Avoid submodule hell.
 
-git clone https://github.com/wonder-mice/zf_log.git
-git clone https://github.com/google/googletest.git
+    git clone https://github.com/wonder-mice/zf_log.git
+    git clone https://github.com/google/googletest.git
 
-sudo apt install cmake
+    sudo apt install cmake
 
-cmake .
-make
+    cmake .
+    make
 
 # Also:
 
-codium clang-format extension
+* codium clang-format extension
+* codium c/c++ advanced lint
 
-apt install clang-format
+    apt install clang-format clang cppcheck
 
 # Build a "release" build
 
-cmake -DCMAKE_BUILD_TYPE=Release .
-make
+    cmake -DCMAKE_BUILD_TYPE=Release .
+    make
 
 # To switch back to "debug" build
 
-cmake -DCMAKE_BUILD_TYPE=Debug .
-make
+    cmake -DCMAKE_BUILD_TYPE=Debug .
+    make
+
+# Branches
+    git checkout -b new-branch
+
+or, a longer way to type that:
+
+    git branch new-branch
+    git checkout new-branch
+
+    git commit 
+
+And your changes go into the new-branch
+
+## Pushing your new branch
+
+    git push -u origin new-branch
+    
+If you recall using git push -u when you first setup the git repo.  Well, it's that all over again, but with a new branch.
+
+## Returning to reality
+
+    git checkout master
+
+## Pulling files from one branch into another
+
+    git checkout master
+    git checkout bugz-ansi -- ghost.ans ghead.ans bat.ans utils.h utils.cpp
+
+This would pull files from bugz-ansi branch into the master branch.