diff --git a/src/lay/lay/doc/about/packages.xml b/src/lay/lay/doc/about/packages.xml index 485921322..8abfd6e26 100644 --- a/src/lay/lay/doc/about/packages.xml +++ b/src/lay/lay/doc/about/packages.xml @@ -145,7 +145,7 @@
- For public deployment, the Salt.Mine Service is used to register + For public deployment, the Salt.Mine service (http://sami.klayout.org) is used to register new packages in the package index. By default, KLayout loads the package index from that service, so once your package is registered there, everyone using KLayout will see it.
@@ -155,4 +155,50 @@ process. ++ Packages are published on the Salt.Mine server. This is a web service that delivers a + packages index with some meta data such as current version, the icon + and a brief description. KLayout uses this list to inform users of packages available + for installation and available updates. The package index can be served by other + ways too. The only requirement is to be accessible by a http, https or file URL. +
+ ++ The basic format of the index is XML with this structure: +
+ +<salt-mine> + <salt-grain> + <name>name</name> + <version>Version</version> + <title>Title of the package</title> + <doc>A brief description</doc> + <doc_url>Documentation URL</doc_url> + <url>Download URL</url> + <license>License model</license> + <icon>Icon image: base64-encoded, 64x64 max, PNG preferred</icon> + </salt-grain> + ... +</salt-mine>+ +
+ When the package manager is opened, KLayout will download the index from + http://sami.klayout.org/repository.xml. You can set the KLAYOUT_SALT_MINE + environment variable to a different URL which makes KLayout use another dictionary + service, i.e. one inside your own organisation. This service can be any HTTP server + that delivers a package list in the same format than the Salt.Mine package service. + The URL can also be a "file:" scheme URL. In this case, KLayout will download the + list from the given file location. +
+ ++ When installing a package, KLayout will simply download the files from the URL given + in the package list. KLayout employs the WebDAV protocol to download the files. + This protocol is spoken by Subversion and GitHub with the subversion bridge. The + latter requires a simple translation of the original Git URL's to obtain the + subversion equivalent. +
+