1,847
edits
Octave Forge: Difference between revisions
Rename "Octave-Forge" to "Octave Forge" (https://lists.gnu.org/archive/html/octave-maintainers/2018-08/msg00138.html).
(Rename "Octave-Forge" to "Octave Forge" (https://lists.gnu.org/archive/html/octave-maintainers/2018-08/msg00138.html).) |
(Rename "Octave-Forge" to "Octave Forge" (https://lists.gnu.org/archive/html/octave-maintainers/2018-08/msg00138.html).) |
||
| Line 1: | Line 1: | ||
Octave | Octave Forge is a community project for collaborative development of GNU Octave extensions, called “Octave packages”. If you have a large package that you want to open up to collaborative development, or a couple of m-files that you want to contribute to an existing package, Octave Forge is the place to do it. Tiny helper functions (the equivalent of e.g., shell aliases) should go in the [[Tips and tricks]] page. | ||
== Installing packages == | == Installing packages == | ||
You can find the list of packages on the [http://octave.sourceforge.net/packages.php Octave | You can find the list of packages on the [http://octave.sourceforge.net/packages.php Octave Forge website]. The recommended method for package installation is using your system package manager, see also the [[FAQ]] for the most common issues. The official [[Windows Installer]] bundles several packages so they don't have to be installed separately. | ||
To install a package from the Octave Forge, at the Octave prompt type {{Codeline|pkg install -forge package_name}}. If your Octave version is below 3.4.0, you'll have to download the package file manually, and use {{Codeline|pkg install package_file_name.tar.gz}}. | To install a package from the Octave Forge, at the Octave prompt type {{Codeline|pkg install -forge package_name}}. If your Octave version is below 3.4.0, you'll have to download the package file manually, and use {{Codeline|pkg install package_file_name.tar.gz}}. | ||
| Line 23: | Line 23: | ||
'''Package maintainer''' | '''Package maintainer''' | ||
* Maintains package content (m-files, C and fortran code, documentation, bundled libraries, other content) inside the source code repository, see [https://www.gnu.org/software/octave/doc/interpreter/Creating-Packages.html]. If the code is developed elsewhere, the repository must be pushed to Octave | * Maintains package content (m-files, C and fortran code, documentation, bundled libraries, other content) inside the source code repository, see [https://www.gnu.org/software/octave/doc/interpreter/Creating-Packages.html]. If the code is developed elsewhere, the repository must be pushed to Octave Forge at release time. | ||
* Keeps the package in good shape, e. g., installability on many systems, up-to-date INDEX, DESCRIPTION, NEWS … files | * Keeps the package in good shape, e. g., installability on many systems, up-to-date INDEX, DESCRIPTION, NEWS … files | ||
* Manages package licensing | * Manages package licensing | ||
| Line 40: | Line 40: | ||
** Must install and work with the latest stable Octave release | ** Must install and work with the latest stable Octave release | ||
** License compliance (must be released under a GPL compatible license) | ** License compliance (must be released under a GPL compatible license) | ||
** The corresponding source code revision must be tagged inside the Octave | ** The corresponding source code revision must be tagged inside the Octave Forge repository and it must be possible to reproduce the content of the release tarball from this revision. Aforementioned Makefile can help with this task. | ||
** Content has been signed by the package maintainer or matching hash values have been provided via the package release ticket | ** Content has been signed by the package maintainer or matching hash values have been provided via the package release ticket | ||
** All functions (except private ones) must be documented using Texinfo | ** All functions (except private ones) must be documented using Texinfo | ||
| Line 50: | Line 50: | ||
'''Forge leader''' | '''Forge leader''' | ||
* Decides about entry of new packages to Octave | * Decides about entry of new packages to Octave Forge | ||
* Categorizes the list of maintained and unmaintained packages | * Categorizes the list of maintained and unmaintained packages | ||
* Administrates the SourceForge project | * Administrates the SourceForge project | ||
| Line 72: | Line 72: | ||
== External links == | == External links == | ||
* [http://octave.sf.net Octave | * [http://octave.sf.net Octave Forge website] | ||
[[Category:Octave | [[Category:Octave Forge| ]] | ||