Skip to content

Commit

Permalink
1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
zbbamboo committed Apr 24, 2023
1 parent 380fe00 commit 3f211b7
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Writing the header docu will be done by the defined writer pluging (e.g.: json,
The future default writer plugin will be adoc (ASCIIdoc) so fileheader_docu can be used as an export task (binary) to doctoolchain.


_scanned / collected Meta data:_
*scanned / collected Meta data:*_*

(depends on parser-/writer plug-ins and inifile configuration)

Expand All @@ -88,7 +88,7 @@ _scanned / collected Meta data:_
- DEPENDENCIES
- HISTORY

_scanned / collected file attributes:_
*scanned / collected file attributes:*

- FILE_Name
- FILE_baseFileName
Expand Down Expand Up @@ -140,6 +140,10 @@ see:

### Prerequisites

the Linux AppImage should run on most newer x86_64 Linux system

(for compiling and linking):

- PC or Laptop with Windows, MacOS or Linux \*\_^
- installed C++ compiler like g++ or clang++ with C++17 support
- developer tools with cmake
Expand Down Expand Up @@ -219,7 +223,7 @@ Usage:
```
./Fileheader_Docu-x86_64.AppImage --listini --ini <pathTo/inifile>
```
*parse folder recursively for files with extension *.cpp, write to target folder with parser plug-in doxygen and writer plug-in json*
_parse folder recursively for files with extension *.cpp, write to target folder with parser plug-in doxygen and writer plug-in json_
```
./Fileheader_Docu-x86_64.AppImage --dir ./ESP32_libs --ext *.cpp --out ./ESP32_libs/docu --parser doxygen --writer json
```
Expand Down

0 comments on commit 3f211b7

Please sign in to comment.