repoutils

rootReadmeGenerator

• Use this program to generate the readme file in the root directory.
  
• Readme file is "README.md" by default, but can be changed in GeneratorBase.cpp
  
• If a readme file is present, will generate entries only for missing chapters (assumes there are no gaps between entries and starts from 1)
  
• Takes one argument: the chapter number to generate entries for.
  
• Example to generate entries for chapters 1-19:
  

./rootReadmeGenerator 19

If a readme file exists, the program will output how many chapter entries were found in the file.

• Compiling:
  

clang++ -c ../GeneratorBase.cpp RootReadme.cpp main.cpp
clang++ GeneratorBase.o RootReadme.o main.o -o rootReadmeGenerator

---

chapterReadmeGenerator

• Use this program to generate the readme files in the chapters' directories.
  
• Readme file is "README.md" by default, but can be changed in GeneratorBase.cpp
  
• If a readme file is present, will generate entries only for missing exercises (assumes there are no gaps between entries and starts from 1)
  
• Takes two arguments: the current chapter number, and the exercise number to generate entries for.
  
• Example to generate entries in chapter 1, for exercises 1-25:
  

./chapterReadmeGenerator 1 25

If a readme file exists, the program will output how many exercise entries were found in the file.

• Compiling:
  

clang++ -c ../GeneratorBase.cpp ChapterReadme.cpp main.cpp
clang++ GeneratorBase.o ChapterReadme.o main.o -o chapterReadmeGenerator