https://github.com/macports/macports-guide

A guide for MacPorts users and developers
https://github.com/macports/macports-guide

Last synced: about 2 months ago
JSON representation

A guide for MacPorts users and developers

• Host: GitHub
• URL: https://github.com/macports/macports-guide
• Owner: macports
• Created: 2016-10-09T00:31:43.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-06-22T21:51:42.000Z (3 months ago)
• Last Synced: 2024-07-18T23:27:44.838Z (2 months ago)
• Language: CSS
• Homepage: https://guide.macports.org
• Size: 1.52 MB
• Stars: 105
• Watchers: 47
• Forks: 58
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# The MacPorts Guide

The MacPorts guide is the main documentation of MacPorts, providing information

on the use of the port(1) tool, the Portfile format, and the project's

policies.

## Branches

  * **master**:       Automatically published to https://guide.macports.org

  * **release-X.Y**:  Documentation for upcoming releases, not meant to be public yet

When a new MacPorts X.Y.0 is released, the release-X.Y branch will be merged to

master to make the documentation available.

## Building

To generate  the guide, clone the macports-guide repository:

```

$ git clone https://github.com/macports/macports-guide.git

$ cd macports-guide/

```

You will also need the following tools which are required to convert the

DocBook XML sources to the desired output format. You can install them from

MacPorts with this command:

```

$ sudo port install libxml2 libxslt docbook-xsl-ns docbook-xml-5.0

```

### HTML Output

To generate the guide just run `make` in this directory; the HTML version will

be placed in `guide/html/`.

```

$ make

$ open guide/html/index.html

```

### PDF Output

In addition to the dependencies listed above, the PDF output format also

requires the `dblatex` port.

```

$ sudo port install texlive-lang-cyrillic dblatex

```

To generate a PDF version of the guide, use `make guide-dblatex`.

```

$ make guide-dblatex

$ open guide/dblatex/macports-guide.pdf

```