ADD: updated readme

CMakeLists.txt

@@ -14,7 +14,7 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 cmake_minimum_required (VERSION 3.1 FATAL_ERROR)
-project (buildIt-server VERSION 0.1.0 LANGUAGES  CXX)
+project (repobadge VERSION 0.1.0 LANGUAGES  CXX)
 list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake/Modules )
 
 set(CMAKE_CXX_STANDARD 14)
@@ -29,7 +29,6 @@ include(compdb)
 # provide all source files for the server
 set(REPOBADGE_SOURCES
   include/repoBadge.hpp
-  src/svg.hpp
   src/repoBadge.cpp
 )
 

README.md

@@ -4,6 +4,22 @@
 
 C++ library and tool for creating code repository badges
 
+
+## Building
+
+- mkdir build
+- cd build
+- cmake ..
+- make all
+- make test
+
+### Doxygen Documentation
+
+- mkdir build
+- cd build
+- cmake ..
+- make doc-repobadge
+
 ## License
 
 GPLv3