Skip to content
Tools for distributing OCaml software on erratique.ch
Shell OCaml
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
bin
jsoo
pkg
.gitignore
README.md
opam
pkgopkg.install

README.md

pkgopkg — Tools for distributing OCaml software on erratique.ch

Ad-hoc tools to develop and distribute OCaml software.

Installation

To install:

opam pin add pkgopkg http://erratique.ch/repos/pkgopkg.git

The installed tools are described in the bin section below.

bin

These tool must be invoked in the root directory of a project.

  • pkg-doc generate the documentation of package.
  • reload-browser reload an URI in a browser tab.
  • pkg-update-support update the package independent support file in the pkg of a project.
  • pkg-opam-descr extract an opam descr from a README.md file on stdout.
  • pkg-distrib make a distribution tarball in /tmp.
  • pkg-www-release publish the distribution tarball created by pkg-distrib on erratique.ch.
  • pkg-opam-pkg make an opam package for the distribution tarball created by pkg-distrib.
  • pkg-www-doc publish the documentation of the project on erratique.ch.
  • pkg-www-demos publish the jsoo demos of the project on erratique.ch.
  • repo-make-public from a local repo and a description make a master remote repo with a github mirror.

pkg

To packagify a project.

** Deprecated ** Use topkg instead.

  1. Copy pkg directory to root directory of the distribution.
  2. Add pkg/config with at least $NAME, $VERSION and $MAINTAINER. E.g.

    NAME=example
    VERSION=`git describe master | sed "s/^.//"`
    MAINTAINER="Daniel Bünzli <daniel.buenzl i\\\@erratique.ch>"
    
  3. Add pkg/META describing the library.
  4. Add pkg/build describing what to install using pkg-builder
  5. Add an opam file describing the library.

jsoo

Something went wrong with that request. Please try again.