		  _ _ _
		 | (_) |__    ______________ _
		 | | | '_ \  / ___/ ___/ __ `/____
		 | | | |_) |/ /__/ /  / /_/ / ___/
		 |_|_|_.__/ \___/_/   \__,_(__  )
					 /____/ /_
					     / __ \
					    / / / /
					`\*/_/ /_/*/'
======================================================================

Libcrash is a library to generate crash reports when a program
crashes.


How do I use it?
================

The API is very simple. There are only three functions: crash_init(),
crash_init_signals(), and crash_abort().

The thing your program should do is call crash_init(). Pass it
argv[0], the full name of your program (including version number if
you'd like that to get printed too), and the bug report email address
(or NULL if none).

If you'd like to use a different set of signals than the default, use
crash_init_signals() and pass it an array of signals and the size of
that array.

crash_abort() will initiate the crash report (it does not
return). However, you should not call crash_abort() directly. Instead,
you should call crash_init() once, and then whenever you'd like to
crash, use assert(0) or abort().

Usually, however, you will not need to crash manually like
that. Instead, just assert(<failed assertion here>), or deference
NULL, or whatever it is you inferior programmers like to do, and
crash_abort() will be called automatically.


Installing
==========

Running

  $ ./configure && make && sudo make install

will configure, compile, and install the package in /usr/local. Then
you will need to run (as root)

  # ldconfig

to register the library with the system.

See the file INSTALL for more information.


(Not So) Frequently Asked Questions <---\
===================================	|
					|
Er, make that "question". --------------/

Q: Why don't you support proprietary systems such as M$ Windoze and
Mac OS Sucks?

A: Any attempt to recover from a crash on those systems is
futile. Besides, they are evil and you shouldn't be using them
anyway. Currently, only GNU/Linux is supported, but I would be happy
to support other free operating systems too.



======================================================================

Copyright (C) 2019  Asher Gordon <AsDaGo@posteo.net>

Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.  This file is offered as-is,
without any warranty.
