diff --git a/README.md b/README.md index 336dd78..12d8b8b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,27 @@ # c2html A tool to add HTML syntax highlighting to C code. -Basically you give `c2html` some C code as input and it classifies all the keywords, identifiers etc using `` elements, associating them with the appropriate class names. By applying the `style.css` stylesheet to the generated output, you get the highliting. If you prefer, you can write your own style. +Basically you give `c2html` some C code, and it annotates it with HTML `` elements that have class names describing the type of token. + +For example, by providing it with the code +```c +int a; +``` +the output is +```html +
+
+ + + + +
1 + int a; +
+
+
+``` +therefore you can apply custom color schemes by selecting the tokens from your CSS. A default stylesheet you can use is provided in `style.css`. # Index 1. [Install](#install) @@ -18,33 +38,33 @@ Basically you give `c2html` some C code as input and it classifies all the keywo # Install ## Supported platforms -The code is very portable so it's 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 possible to run it everywhere, although there are only build and install scripts for \*nix systems. ## 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. +There is no particular way to install the library. The code is so small that you can just drop `c2html.c` and `c2html.h` in your project and use then as they were your own. ## Install the command-line interface To install the `c2html` command under **linux**, you first have to build it by running `build.sh`, then you can install it with `install.sh`. You may need to give these scripts execution privileges first. You can do that by running `chmod +x build.sh` and `chmod +x install.sh`. +Once the CLI is installed, you'll be able to use the `c2html` command in your terminal. + # Usage c2html comes both as a C library and a command-line utility. ## Using the command-line interface -By running `build.sh`, the `c2html` executable is built, which is command-line interface of c2html. - You can highlight your C files by doing ```sh -./c2html --input file.c --output file.html +c2html --input file.c --output file.html ``` -This command will generate the highlighted C code. +which will read `file.c` and generate `file.html`. To know more, you can always run `c2html --help`. ### --style The HTML comes with no styling. If you want to apply a CSS to it, you can provide to `c2html` a style file using the `--style` option followed by the name of the file. ```sh -./c2html --input file.c --output file.html --style style.css +c2html --input file.c --output file.html --style style.css ``` This will basically add a `