distribute ".txt" files without markup

[MarkBergman-cbica]

The various text file contain markup directives, making them very difficult to read. For example, 5_TechReference.txt has the following instructions for building CaPTk:

<table border="0">
    <tr>
      <td width="7%"><strong>Package</strong></td>      
      <td width="7%"><strong>Version</strong></td>      
      <td width="100%"><strong>Description</strong></td>  
    </tr>
    <tr>
      <td>Archiver</td>
      <td>n/a</td>
      <td>gzip (http://www.gzip.org/) is recommended. <br><b>Windows Users</b>: 7-zip (http://www.7-zip.org/)</td>
    </tr>
    <tr>
      <td>C++ compiler</td>
      <td>n/a</td>
      <td>Visual Studio 2017, GCC/4.9.2, LLVM 6.0.1 are supported; C++11 compliant compiler is needed</td>
    </tr>
    <tr>
      <td>CMake (http://www.cmake.org/)</td>
      <td>3.10 or higher</td>
      <td>To configure the CaPTk compilation along with its dependencies.</td>

The files should be renamed, and plain-ASCII-text versions created (named with the '.txt' extension).

[sarthakpati]

The actual package ships with the HTML pages. Unclear what removing the markdown would achieve other than the necessity to maintain 2 documentation sources.

[MarkBergman-cbica]

The marked-up documents are difficult to read via the command-line, particularly 5_TechReference.txt.

The goal is to eliminate the current barrier to building CaPTk when working from the command-line.

There is no need to maintain multiple documentation sources. Think of the marked-up documentation as source code. The distributed package should contain a processed version of that documentation, as a plain-ASCII file without markup. This can be done easily from an HTML source (ie., 'lynx -dump', 'elinks -dump', etc).

[sarthakpati]

I would assume something like this would solve our issues?

[sarthakpati]

Another solution: https://www.npmjs.com/package/doxygen2md

[sarthakpati]

Another project based on doxygen2md: https://devhub.io/repos/sourcey-moxygen

[sarthakpati]

@surrsurus : could you take a look at the latter project to see if the conversion is straightforward? I was not able to install it on my Windows machine. The usage is pretty simple: just direct the input as $captk_bin/docs/xml and the project should take care of the rest.