README@15fe9c1d7f1a (annotated)
README
Sat, 15 Feb 2025 23:26:08 +0100
- author
- Mike Becker <universe@uap-core.de>
- date
- Sat, 15 Feb 2025 23:26:08 +0100
- changeset 88
- 15fe9c1d7f1a
- parent 87
- a53fa82bbdcf
- permissions
- -rw-r--r--
bring back the c2html_bformat() function
fixes #592
|
87
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
1 | c2html - Formats source code using HTML. |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
2 | |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
3 | Build Instructions: |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
4 | |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
5 | 1. Download and install UCX (https://ucx.sourceforge.io) |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
6 | 2. Run ./configure --release |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
7 | 3. Run make (produces c2html binary in build directory) |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
8 | 4. Or run make lib (produces include dir and static lib in dist directory) |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
9 | |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
10 | Usage of binary file: |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
11 | c2html [Options] FILE |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
12 | |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
13 | Options: |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
14 | -h Prints help message |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
15 | -j Highlight Java instead of C source code |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
16 | -o <output> Output file (stdout, if not specified) |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
17 | -H <header> Prepend header file |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
18 | -F <footer> Append footer file |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
19 | -p Disable highlighting (plain text) |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
20 | -l Disable line numbers |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
21 | -V, -v Prints version and exits |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
22 | |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
23 | Usage of static library: |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
24 | |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
25 | 1. Copy the contents of the dist directory to your project. |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
26 | 2. Include c2html.h and use one of the functions declared in this header |
|
a53fa82bbdcf
upgrade uwproj and add lib target and README
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
27 | 3. Link against the libc2html.a |
