dany/pdfio
1
0
Fork 0
mirror of https://github.com/michaelrsweet/pdfio.git synced 2024-12-26 05:18:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING docos.

Browse Source
This commit is contained in:
Michael R Sweet 2023-12-05 14:07:52 -05:00
parent 34dbf6c2fe
commit a0cdb261ff
No known key found for this signature in database
GPG Key ID: BE67C75EC81F3244
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
CONTRIBUTING.md
View File

@ -43,14 +43,17 @@ Contents
Build System Build System
------------ ------------
The build system uses a simple POSIX makefile to build a static or shared The build system uses [GNU autoconf][AUTOCONF] to create a simple POSIX makefile
library. To improve portability, makefiles *must not* make use of features to build static and/or shared libraries. To improve portability, makefiles
unique to GNU make. See the [Makefile Guidelines](#makefile-guidelines) section *must not* make use of features unique to GNU make. See the
for a description of the allowed make features and makefile guidelines. [Makefile Guidelines](#makefile-guidelines) section for a description of the
allowed make features and makefile guidelines.
An Xcode project is provided for macOS/iOS developers, and a Visual Studio An Xcode project is provided for macOS/iOS developers, and a Visual Studio
solution and projects for Windows developers. solution and projects for Windows developers.
[AUTOCONF]: https://www.gnu.org/software/autoconf/
Version Numbering Version Numbering
----------------- -----------------
@ -373,14 +376,15 @@ The following variables are defined in the makefile:
- `CC`; the C compiler command, - `CC`; the C compiler command,
- `CFLAGS`; options for the C compiler, - `CFLAGS`; options for the C compiler,
- `CODESIGN_IDENTITY`: the code signing identity, - `CODESIGN_IDENTITY`: the code signing identity,
- `COMMONFLAGS`; common compiler optimization options,
- `CPPFLAGS`; options for the C preprocessor, - `CPPFLAGS`; options for the C preprocessor,
- `DESTDIR`/`DSTROOT`: the destination root directory when installing. - `DESTDIR`/`DSTROOT`: the destination root directory when installing.
- `DSO`; the shared library building command, - `DSO`; the shared library building command,
- `DSOFLAGS`; options for the shared library building command, - `DSOFLAGS`; options for the shared library building command,
- `DSONAME`: the root name of the shared library
- `LDFLAGS`; options for the linker, - `LDFLAGS`; options for the linker,
- `LIBPDFIO`: the name of the primary (shared or static) library
- `LIBPDFIO_STATIC`: the name of the secondary (static) library
- `LIBS`; libraries for all programs, - `LIBS`; libraries for all programs,
- `OPTIM`; common compiler optimization options,
- `prefix`; the installation prefix directory, - `prefix`; the installation prefix directory,
- `RANLIB`; the static library indexing command, - `RANLIB`; the static library indexing command,
- `SHELL`; the sh (POSIX shell) command, - `SHELL`; the sh (POSIX shell) command,
@ -389,12 +393,7 @@ The following variables are defined in the makefile:
The following standard targets are defined in the makefile: The following standard targets are defined in the makefile:
- `all`; creates the static library and unit test program. - `all`; creates the static library and unit test program.
- `all-shared`; creates a shared library appropriate for the local system.
- `clean`; removes all target programs libraries, documentation files, and - `clean`; removes all target programs libraries, documentation files, and
object files, object files,
- `debug`: creates a clean build of the static library and unit test program
with debug printfs and the clang address sanitizer enabled.
- `install`; installs all distribution files in their corresponding locations. - `install`; installs all distribution files in their corresponding locations.
- `install-shared`; same as `install` but also installs the shared library.
- `macos`; same as `all` but creates a Universal Binary (X64 + ARM64).
- `test`; runs the unit test program, building it as needed. - `test`; runs the unit test program, building it as needed.