Skip to content

Commit be7887a

Browse files
committed
README.md: Publishing. More improvments.
1 parent 60c1a86 commit be7887a

1 file changed

Lines changed: 27 additions & 8 deletions

File tree

README.md

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,15 @@ Of course you can use this package template outside GitHub as well.
1313
> Just copy the files from the ZIP-archive into your fresh repository
1414
> or follow the guide below.
1515
16+
Outline:
1617

17-
## 1. Setup your repository
18+
1. Setup your package repository
19+
2. Change your package repository to your needs
20+
3. Install your package
21+
4. Publish your package
22+
23+
24+
## 1. Setup your package repository
1825

1926
- Join the [GNU Octave GitHub organization](https://github.com/gnu-octave)
2027
by asking for invitation at our
@@ -28,15 +35,12 @@ Of course you can use this package template outside GitHub as well.
2835
![img](doc/create_repo_2.png)
2936

3037

31-
## 2. Change your repository to your needs
38+
## 2. Change your package repository to your needs
3239

3340
In this section we give a brief introduction to the files and folders of this
3441
repository and Octave packages in general. We do not use all features of
3542
Octave packages. For a more complete feature documentation, see
3643
[the Octave manual](https://octave.org/doc/latest/Creating-Packages.html).
37-
38-
### Necessary files in the root directory of your package
39-
4044
The following graphic gives an overview about what is installed
4145
from this package repository.
4246

@@ -50,7 +54,7 @@ installation location.
5054
specialist in software law, we recommend to use a well established software
5155
license. See <https://spdx.org/licenses/> for examples.
5256

53-
- [`DESCRIPTION`](DESCRIPTION) and [`INDEX`](INDEX): as defined in
57+
- [`DESCRIPTION`](DESCRIPTION) and [`INDEX`](INDEX): As defined in
5458
[the Octave manual](https://octave.org/doc/latest/Creating-Packages.html).
5559

5660
- These three files are installed to a directory `packinfo` and tools like
@@ -80,7 +84,7 @@ installation location.
8084
- `NEWS`: If this file is provided, the command `news pkg-example` prints it
8185
on the screen.
8286

83-
- [`doc`](doc): Optional folder. All content is copied as is to the package
87+
- [`doc`](doc): Optional folder. All content is copied to the package
8488
installation directory.
8589

8690
- [`src`](src): **All source code** (Octave m-files, C/C++, and FORTRAN) goes
@@ -95,7 +99,7 @@ installation location.
9599
> package installation directory.
96100
97101

98-
## 3. Installing your package
102+
## 3. Install your package
99103

100104
You can always install the latest development version of your package,
101105
for example the `master` branch, with the command:
@@ -132,3 +136,18 @@ copyfile /tmp/oct-1zkcqo/pkg-example-master/src/hello_world.m /tmp/oct-1zkcqo/pk
132136
copyfile /tmp/oct-1zkcqo/pkg-example-master/src/fortran_demo.oct /tmp/oct-1zkcqo/pkg-example-master/src/oct_demo.oct /tmp/oct-1zkcqo/pkg-example-master/src/mex_demo.mex /tmp/oct-1zkcqo/pkg-example-master/inst/x86_64-pc-linux-gnu-api-v53
133137
warning: doc_cache_create: unusable help text found in file 'mex_demo'
134138
```
139+
140+
141+
## 4. Publish your package
142+
143+
> What is the use of your package, if only you know about it?
144+
145+
You have several options to gain attention, ordered by difficulty:
146+
147+
1. Announce your package at <https://octave.discourse.group/>.
148+
2. Announce your package at <https://wiki.octave.org/Packages>.
149+
3. Add your package to the
150+
[GNU Octave - Package extensions index](https://gnu-octave.github.io/pkg-index/).
151+
4. Add your package to [Octave Forge](https://octave.sourceforge.io/packages.php)
152+
(notice that your package
153+
[must meet additional criteria](https://octave.sourceforge.io/developers.php)).

0 commit comments

Comments
 (0)