Skip to content

Commit e99bb73

Browse files
committed
Avoid INDEX file
1 parent da4ea25 commit e99bb73

File tree

4 files changed

+31
-39
lines changed

4 files changed

+31
-39
lines changed

DESCRIPTION

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
Name: pkg-example
2-
Version: 1.0.0
3-
Date: 2020-09-02
4-
Author: Kai T. Ohlhus <[email protected]>
5-
Maintainer: Kai T. Ohlhus <[email protected]>
6-
Title: Minimal example package to demonstrate the Octave package extensions.
7-
Description: Minimal example package to demonstrate the Octave package
1+
name: pkg-example
2+
version: 1.1.0
3+
date: 2021-04-06
4+
author: Kai T. Ohlhus <[email protected]>
5+
maintainer: Kai T. Ohlhus <[email protected]>
6+
title: Minimal example package to demonstrate the Octave package extensions.
7+
description: Minimal example package to demonstrate the Octave package
88
extensions. It shows how to organize Octave, C/C++, and FORTRAN code within
99
a package and to properly compile it.
10+
categories: package
11+
depends: octave (>= 4.0.0)

INDEX

Lines changed: 0 additions & 8 deletions
This file was deleted.

README.md

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -48,23 +48,23 @@ In this section we give a brief introduction to the files and folders of this
4848
repository and Octave packages in general. We do not use all features of
4949
Octave packages. For a more complete feature documentation, see
5050
[the Octave manual](https://octave.org/doc/latest/Creating-Packages.html).
51-
The following graphic gives an overview about what is installed
51+
The following figure gives an overview about what is installed
5252
from this package repository.
5353

5454
![img](doc/directories.png)
5555

56-
On the left side of the graphic above is a clone of this repository.
56+
On the left side of the figure above is a clone of this repository.
5757
On the right side the installed package in the default Octave package
5858
installation location.
5959

6060
- [`COPYING`](COPYING): The license text of the package. If you are not a
6161
specialist in software law, we recommend to use a well established software
6262
license. See <https://spdx.org/licenses/> for examples.
6363

64-
- [`DESCRIPTION`](DESCRIPTION) and [`INDEX`](INDEX): As defined in
64+
- [`DESCRIPTION`](DESCRIPTION): As defined in
6565
[the Octave manual](https://octave.org/doc/latest/Creating-Packages.html).
6666

67-
- These three files are installed to a directory `packinfo` and tools like
67+
- These two files are installed to a directory `packinfo` and tools like
6868
`pkg describe` use this information:
6969

7070
```
@@ -73,29 +73,31 @@ installation location.
7373
Package name:
7474
pkg-example
7575
Version:
76-
1.0.0
76+
1.1.0
7777
Short description:
78-
Minimal example package to demonstrate the Octave package extensions. It shows how to organize Octave, C/C++, and FORTRAN code within a package and to properly compile it.
78+
Minimal example package to demonstrate the Octave package extensions. It shows how to organize Octave, C/C++,and FORTRAN code within a package and to properly compile it.
79+
Depends on:
80+
octave >= 4.0.0
81+
Depended on by:
82+
7983
Status:
8084
Not loaded
8185
---
8286
Provides:
83-
Octave code
87+
package
8488
hello_world
85-
C/C++/FORTRAN code
86-
mex_demo
87-
oct_demo
8889
fortran_demo
90+
oct_demo
8991
```
9092

91-
- `NEWS`: If this file is provided, the command `news pkg-example` prints it
92-
on the screen.
93+
- `NEWS`: If this file is provided,
94+
the command `news pkg-example` prints it on the screen.
9395

94-
- [`doc`](doc): Optional folder. All content is copied to the package
95-
installation directory.
96+
- [`doc`](doc): Optional folder.
97+
All content is copied to the package installation directory.
9698

97-
- [`src`](src): **All source code** (Octave m-files, C/C++, and FORTRAN) goes
98-
here.
99+
- [`src`](src): **All source code** (Octave m-files, C/C++, and FORTRAN)
100+
goes here.
99101

100102
- [`src/Makefile`](src/Makefile): during the package installation,
101103
`pkg install` will call `make` with its default target (not
@@ -149,12 +151,8 @@ warning: doc_cache_create: unusable help text found in file 'mex_demo'
149151

150152
> What is the use of your package, if only you know about it?
151153
152-
You have several options to gain attention, ordered by difficulty:
154+
You have several options to gain attention for your package:
153155

154-
1. Announce your package at <https://octave.discourse.group/>.
155-
2. Announce your package at <https://wiki.octave.org/Packages>.
156-
3. Add your package to the
157-
[GNU Octave - Package extensions index](https://gnu-octave.github.io/pkg-index/).
158-
4. Add your package to [Octave Forge](https://octave.sourceforge.io/packages.php)
159-
(notice that your package
160-
[must meet additional criteria](https://octave.sourceforge.io/developers.php)).
156+
- Add your package to [Octave Packages](https://gnu-octave.github.io/packages/).
157+
- Announce your package at <https://octave.discourse.group/>.
158+
- Announce your package at <https://wiki.octave.org/Packages>.

doc/directories.png

-769 Bytes
Loading

0 commit comments

Comments
 (0)