Update and rename README to README.md #23
Conversation
Formatted README for better readability and scanability. Added section about using octave software for users (not developers).
|
Thank for the pull-request (PR) @nsesodia . This GitHub repository is just a mirror of the mercurial repository, thus there is no guarantee that Octave developers will review this PR. Maybe @mmuetzel can comment how to go forward with changes here.
About the changes themselves. The GNU Standards of The Markdown changes look good, but it depends what the Octave developers prefer, as only pages like GitLab/GitHub display the |
|
Perhaps we can make the formatting changes but leave the file as |
| along with Octave; see the file COPYING. If not, see | ||
| <https://www.gnu.org/licenses/>. | ||
| You should have received a copy of the | ||
| [`GNU General Public License`](https://github.com/gnu-octave/octave/blob/default/COPYING) |
There was a problem hiding this comment.
The GitHub mirror is just that (a mirror of the main repository).
We shouldn't hard-code paths to the mirror repository here.
|
|
||
| Bugs and Patches | ||
| ---------------- | ||
| See [Octave installation guide](https://github.com/gnu-octave/octave/blob/default/doc/interpreter/install.txi) |
There was a problem hiding this comment.
.txi files are sources from which documentation is generated. Users shouldn't need to read those sources.
Maybe, use a link to the generated HTML documentation?
https://docs.octave.org/latest/Installation.html
| Copyright (C) 1996-2024 The Octave Project Developers | ||
|
|
||
| See the file | ||
| [`COPYRIGHT.md`](https://github.com/gnu-octave/octave/blob/default/COPYRIGHT.md) |
There was a problem hiding this comment.
Same as above:
The GitHub mirror is just that (a mirror of the main repository).
We shouldn't hard-code paths to the mirror repository here.
|
Some of the rewording of the file is probably ok. |
| [here](https://ftp.gnu.org/gnu/octave) | ||
| and many mirror sites around the world. You may also find links to binary distributions | ||
| [here](https://www.octave.org/download.html). | ||
| The current development sources may be found under the Source Code tab on [Savannah](https://savannah.gnu.org/projects/octave/). |
There was a problem hiding this comment.
Try to limit line length to 80 characters.
|
No more reaction of the original author in more than 2 weeks. Closing PR. |
Formatted README for better readability and scanability using markup. Added section about using octave software for users (not developers).