Compiling PasDoc from sources

1. Get the source code

First of all, get our source code from GitHub. E.g.

git clone https://github.com/pasdoc/pasdoc.git

2. Build with command-line FPC

You can build with command-line Free Pascal Compiler (FPC).

Requirements: We need FPC with Generics.Collections support, which implies FPC >= 3.2.0.

From the command-line, compile by simply executing

make

in the main repository directory.

Note

You must use GNU make.

  • Under Linux this is the standard make.

  • Under Windows it is included with FPC installation (you can also get it with MinGW or Cygwin).

  • Under FreeBSD it’s called gmake.

  • Under MacOS it’s called gmake and you can install it with brew install make (using Homebrew).

2.1. Build with Lazarus

Lazarus is an IDE using FPC under the hood.

Requirements: Any Lazarus version that supports FPC >= 3.2.0 should be able to compile pasdoc.

  • First, open and build the package with our components by installing source/packages/lazarus/pasdoc_package.lpk.

  • Build the command-line PasDoc by opening the source/console/pasdoc.lpi project in Lazarus and compiling it.

  • Build the GUI PasDoc by opening the source/gui/pasdoc_gui.lpi project in Lazarus and compiling it.

3. Build with Delphi

Requirements: Any Delphi with Generics.Collections support should be good, which in theory means >= 2009. We actively test (using GitHub Actions) with Delphi 10 and 12 right now.

To build the command-line PasDoc, open the Delphi project in source/console/ and build as usual.

4. See also: release making

Compiling, testing and other things related to release making are described on this page: ReleaseMaking.