cozis/c2html
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme fixes

Browse Source
This commit is contained in:
cozis
2022-05-05 19:22:58 +02:00
parent cc51120fec
commit 9ce3c5b15d
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+11 -11
View File
@@ -5,21 +5,21 @@ Basicaly you give `c2html` some C code as input and it classifies all the keywor
# Index # Index
1. [Install](#install) 1. [Install](#install)
1. [Supported platforms](#supported-platforms) - [Supported platforms](#supported-platforms)
2. [Install the library](#install-the-library) - [Install the library](#install-the-library)
3. [Install the command-line interface](#install-the-command-line-interface) - [Install the command-line interface](#install-the-command-line-interface)
2. [Usage](#usage) 2. [Usage](#usage)
1. [Using the command-line interface](#using-the-command-line-interface) - [Using the command-line interface](#using-the-command-line-interface)
1. [--no-table](#--no-table) * [--no-table](#--no-table)
2. [--style](#--style) * [--style](#--style)
2. [Using the library](#using-the-library) - [Using the library](#using-the-library)
# Install # Install
## Supported platforms ## Supported platforms
The code is very portable so it's be possible to run it everywhere, although there are only a build and install script for \*nix systems. The code is very portable so it's be possible to run it everywhere, although there are only a build and install script for \*nix systems.
## Intall the library ## Install the library
To install the library, you just need to copy the `c2html.c` and `c2html.h` files wherever you want to use them and compile them as they were your files. Since the library is so small, you can also just copy the contents of `c2html` in your own project. To install the library, you just need to copy the `c2html.c` and `c2html.h` files wherever you want to use them and compile them as they were your files. Since the library is so small, you can also just copy the contents of `c2html` in your own project.
## Install the command-line interface ## Install the command-line interface
@@ -64,7 +64,7 @@ char *c2html(const char *str, long len, _Bool table_mode,
``` ```
which, given a string containing C code, returns the highlighted version using HTML tags. which, given a string containing C code, returns the highlighted version using HTML tags.
For example, lets consider the For example, consider the following C code:
```c ```c
/* .. include stdlib.h, string.h and stdio.h .. */ /* .. include stdlib.h, string.h and stdio.h .. */
#include "c2html.h" #include "c2html.h"
@@ -86,7 +86,7 @@ int main()
return 0; return 0;
} }
``` ```
will output: when executed, the output will be:
``` ```
<div class="code"> <div class="code">
<div class="code-inner"> <div class="code-inner">
@@ -97,7 +97,7 @@ will output:
</div> </div>
</div> </div>
``` ```
if `table_mode` were `1`, then the output would have been: If `table_mode` were `1`, then the output would have been:
``` ```
<div class="code"> <div class="code">
<div class="code-inner"> <div class="code-inner">