Add the `README'

This commit is contained in:
styan 2020-05-02 23:24:08 +00:00
parent 9737c90fe7
commit fd0cc6daf8
2 changed files with 44 additions and 1 deletions

View File

@ -14,7 +14,7 @@ MAGICBSD=\
export LDFLAGS="$$LDFLAGS `pkg-config --libs libbsd`";\
fi
default: magic-libgeminiclient.a
all: libgeminiclient.a gemini-cat
all: magic
magic: magic-libgeminiclient.a magic-gemini-cat
magic-libgeminiclient.a:
@${MAGICTLS}; ${MAKE} ${MAKEFLAGS} libgeminiclient.a

43
README Normal file
View File

@ -0,0 +1,43 @@
BUILDING
To build libgeminiclient(3) configured automagically:
make
or
make magic-libgeminiclient
To build everything configured automagically:
make all
or
make magic
To build libgeminiclient(3) configured manually:
export CFLAGS=-I/path/to/libtls/includes
make libgeminiclient.a
To build gemini-cat(1) configured manually:
export CFLAGS='-I/path/to/libtls -I/path/to/libbsd'
export LDFLAGS='-L/path/to/libtls -ltls'
make gemini-cat
INSTALLING
To install libgeminiclient(3) on the system:
make install
To install gemini-cat(1) on the system:
make install-gemini-cat
To install everything on the system:
make install-all
To install gemini-cat(1) in your home-directory:
make linstall-gemini-cat
MAGIC
The ``magic'' make(1) targets attempt to use pkg-config(1) for
libraries and their flags.
PREPROCESSOR DEFINES
``BUFFER_SIZE'' The size of the buffer for gemini-cat(1) to use.