Merge branch 'c-master' of git.nikiroo.be:workspace/template
authorNiki Roo <niki@nikiroo.be>
Tue, 2 Jul 2024 15:56:31 +0000 (17:56 +0200)
committerNiki Roo <niki@nikiroo.be>
Tue, 2 Jul 2024 15:56:31 +0000 (17:56 +0200)
1  2 
Doxyfile
Makefile
README.md
src/cutils

diff --cc Doxyfile
index a72e265f41732662ac2a5ce0ad74094c8bd70d4f,cd944e02c5466d44dcba7949cacbe700f5ea3375..10d0e2a3842f0a307463b6ef1d85146ee4464969
+++ b/Doxyfile
@@@ -1,5 -1,14 +1,14 @@@
  # Doxyfile 1.8.13
  
 -PROJECT_NAME           = "Program name"
 -PROJECT_BRIEF          = "Small description"
 -INPUT                  = src/xxx 
+ # Minimum required fields:
++PROJECT_NAME           = "CBook"
++PROJECT_BRIEF          = "PL/1 data files / CSV conversion utility"
++INPUT                  = src/cbook
+ STRIP_FROM_PATH        = src
+ OPTIMIZE_OUTPUT_FOR_C  = YES
+ OPTIMIZE_OUTPUT_JAVA   = NO
+ FILE_PATTERNS          = *.h
  # This file describes the settings to be used by the documentation system
  # doxygen (www.doxygen.org) for a project.
  #
diff --cc Makefile
index 51306d4588090a0d54431da067ca63ad7584ab80,790beea3a6d2827fa2cd1f954dfb320070ad34b9..14e6b85a1aafef3c56b061f9b8a38ab1c630251c
+++ b/Makefile
@@@ -4,10 -4,12 +4,12 @@@
  # > NAMES: list of all the programs to compile
  # > TESTS: list of all test programs to compile and run
  #
 -NAME   = program
 -NAMES  = $(NAME) program2
 -TESTS  = tests-program
 +NAME   = cbook
 +NAMES  = $(NAME) cutils
 +TESTS  = tests-cbook
  
+ ################################################################################
  # You may override these when calling make
  PREFIX = /usr/local
  dstdir = bin
diff --cc README.md
index 0b21b296114af187d081b1a8a6d46ee39e9a958a,2e797e49019e9048cd6cc97e40bcb1ae535a2f13..c3890ec61f2adaf1a36169237e3b4d62b807b0c7
+++ b/README.md
@@@ -4,4 -4,33 +4,35 @@@ PL/1 data files to CSV conversion utili
  
  ## Synopsis
  
- Todo.
 -- `program --help`
++- `cbook --help`
+ ## Description
 -Long description multiple paragraphs are ok.
++PL/1 data files to CSV conversion utility.
++
++Works with EBCDIC data and PL/1 books.
+ ## Options
+ - **--help** (or **-h**): information about the syntax
+ ## Compilation
+ Just run `make`.  
+ You can also use those make targets:
+ - `make doc`: build the Doxygen documentation (`doxygen` required)
+ - `make man`: build the man page (`pandoc` required)
+ - `make install PREFIX=/usr/local`: install the program into PREFIX (default is `/usr/local`) and the manual if built
+ - `make uninstall PREFIX=/usr/local`: uninstall the program from the given PREFIX
+ - `make clear`: clear the temporary files
+ - `make mrpropre`: clear everything, including the main executable and the documentation
+ - `make test`: build the unit tests (`check` required)
+ - `make run-test`: start the unit tests
+ - `make run-test-more`: start the extra unit tests (can be long)
+ ## Author
 -Program was written by Niki Roo <niki@nikiroo.be>
++CBook was written by Niki Roo <niki@nikiroo.be>
diff --cc src/cutils
index 780c8d0590a2f34e68ff896058b3b1a89539dcd8,0000000000000000000000000000000000000000..8cf0ab8f25623889760fef03414c476c1cc19613
mode 160000,000000..160000
--- /dev/null
@@@ -1,1 -1,0 +1,1 @@@
- Subproject commit 780c8d0590a2f34e68ff896058b3b1a89539dcd8
++Subproject commit 8cf0ab8f25623889760fef03414c476c1cc19613