~nytpu/genc

script to generate a c project template
fix makefile
fix typo
update to use smol-c-libs

refs

master
browse  log 

clone

read-only
https://git.sr.ht/~nytpu/genc
read/write
git@git.sr.ht:~nytpu/genc

You can also use your local clone with git send-email.

README(7)	       Miscellaneous Information Manual		     README(7)

NAME
     genc – c project generator

DESCRIPTION
     genc(1) automatically generates a C project template.  It generates a
     project with the following files (note that <TITLE> is replaced with the
     given project title):

     README.7
	     Template README page in mdoc(7) markup.

     <TITLE>.1
	     Template man(1) page in mdoc(7) markup.

     main.c  Template C source file including skeleton for parsing flags with
	     getopt(3).

     common.h
	     Template header file that includes defines to ensure ISO C and
	     POSIX Compliance.

     configure
	     A configure script in POSIX sh(1).	 Can be trivially modified to
	     add the libraries required for your project.

     Makefile
	     A 100% POSIX make(1) makefile.  Can be trivially modified to do
	     preprocessing, add your own rules, etc.

     testing.h
	     Very simple unit testing framework.

     err.c & err.h
	     Error and warning reporting functions.

     LICENSE
	     Plaintext version of the selected license.

     .clang-format
	     Entirely custom config file for clang-format(1) for nytpu's
	     personal C style.	Not included if the -f flag is passed.

     .editorconfig
	     EditorConfig: https://editorconfig.org/ for nytpu's personal C
	     style.

     .gitignore
	     .gitignore set up to ignore build artifacts created by Makefile.

INSTALLING
   REQUIREMENTS
     •	 POSIX or POSIX-compatible sh(1).

     •	 POSIX-mandated system utilities.

     •	 git(1).

     •	 A C99 or C11 compiler.

     •	 man(1) utility compatible with mdoc(7).

     •	 curl(1).

     •	 clang-format(1) (optional).

     •	 scan-build(1) ⟨https://clang-analyzer.llvm.org/scan-build.html⟩
	 (optional).

     •	 include-what-you-use(1)
	 ⟨https://github.com/include-what-you-use/include-what-you-use⟩
	 (optional).
     Just clone the repo and symlink/copy the script to an appropriate
     location in your PATH.

CONTRIBUTING
     The upstream URL of this project is ⟨https://git.nytpu.com/genc⟩.	Send
     suggestions, bugs, and other contributions to <alex [at] nytpu.com>.  For
     help sending a patch through email, see ⟨https://git-send-email.io⟩.

SEE ALSO
     genc(1)

COPYRIGHT
     genc is Copyright (C) 2021 nytpu <alex [at] nytpu.com>.

     genc is licensed under the terms of the GNU Affero General Public
     License.  For more information, see LICENSE or
     ⟨https://www.gnu.org/licenses/agpl-3.0.html⟩.

STANDARDS
     The genc documentation and source code all conform to IEEE Std
     1003.1-2008 (“POSIX.1”) in all cases where the said standard is
     applicable.

nytpu.com			  June 21, 21			     nytpu.com