Bug #5843
closed
SaxonC releases readme
100%
Description
For SaxonC 12, the release zips now contain a top level README.md file. This was modified from the readme which was previously only used to generate the index.html page of the C++ API documentation.
- The readme used for the C++ API documentation should be changed back to make more sense there.
- The readme for SaxonC releases should be reviewed further (e.g. compare this to the doc/index.html file which goes in SaxonJ releases).
Updated by Debbie Lockett over 1 year ago
I've committed changes to separate the readmes:
- src/main/c/README.md is the one for the releases (containing @@ terms which get replaced accordingly for different editions, etc.)
- src/main/c/Saxon.C.API/README.md is the one used by doxygen for the C++ API documentation.
It would be good to exclude the file Saxon.C.API/README.md from the releases entirely, to avoid confusion (and in fact I think the Doxyfile could be excluded too), but I have not yet worked out where in the build to amend this.
Updated by O'Neil Delpratt over 1 year ago
I have made the change to exclude src/main/c/Saxon.C.API/README.md in the cradle build script.
Updated by Debbie Lockett about 1 year ago
- Status changed from In Progress to Resolved
Further build script changes committed to correctly exclude src/main/c/Saxon.C.API/README.md (and other Saxon.C.API content which was mistakenly copied).
Releases readme src/main/c/README.md content updated to add more links for documentation, bug tracker, etc.
Updated by O'Neil Delpratt about 1 year ago
- Status changed from Resolved to Closed
- % Done changed from 0 to 100
- Fixed in version set to 12.1
Bug fixed applied in the SaxonC 12.1 maintenance release.
Please register to edit this issue
.