____ _ _ _ _ _ _ _ / ___| _ _ | | | | |_(_) (_) |_ _ _ | | (_|_) | | | | __| | | | __| | | | | |___ _ _ | |_| | |_| | | | |_| |_| | \____| (_|_) \___/ \__|_|_|_|\__|\__, | |___/ This is the README for C::Utility version 0.012. C::Utility is a "module" for the Perl computer programming language, a library of computer code to install on a computer. This document contains four sections: 1. About - what the module does 2. Documentation - how to learn more about the module 3. Installation - how to install this module on a computer 4. Help - what to do if you get stuck ----------------------------------------------------------------------------- 1. ABOUT C::Utility - utilities for generating C programs This module contains functions which assist in automatic generation of C programs. For work with strings, "convert_to_c_string" converts a string into a string with characters correctly escaped for use in a C program. "convert_to_c_string_pc" does the same thing plus escaping percent signs so that they may be used as format strings for printf. "escape_string" escapes double quotes. "valid_c_variable" checks whether a string is valid as a C variable. The module contains various line directive related functions. "line_directive" prints a C line directive. "linein" and "lineout" offer a preprocessor and postprocessor to add line numbers to files made from templates. ----------------------------------------------------------------------------- 2. DOCUMENTATION You can read the documentation for the module online at the following websites: * http://search.cpan.org/perldoc?C::Utility * http://metacpan.org/release/C-Utility (These links go to the latest version of the module.) After installing the module, you can read the documentation on your computer using perldoc C::Utility ----------------------------------------------------------------------------- 3. INSTALLATION This module requires Perl version 5.6.1 or later. To install the module from CPAN, use cpan C::Utility If you have the App::cpanminus installer, you may prefer cpanm C::Utility To install the module from the source file, C-Utility-0.012.tar.gz, follow this sequence of commands: tar xfz C-Utility-0.012.tar.gz cd C-Utility-0.012 perl Makefile.PL make make install If you want to test the module before installing it, use "make test" after "make" and before "make install". ----------------------------------------------------------------------------- 4. HELP To get help with the module, you can email the author, Ben Bullock, at . If you think there is a problem in the module, you can report a bug at , or if you want to alter the source code of C::Utility, try the public repository on github at . ----------------------------------------------------------------------------- This README was written on Sat Sep 1 11:03:16 2018. -----------------------------------------------------------------------------