search

benjaminbolling / DynaGUI

A Dynamic Graphical User Interface package, which gives users a method to construct temporary, permanent and/or a set of GUI:s for users in a simple and fast manner combined with diagnostics tools (with advance 1D and 2D plotting methods).
GNU General Public License v3.0
6 stars 3 forks source link

Fix formatting of README.md #5

Closed Chilipp closed 4 years ago

Chilipp commented 4 years ago

This issue is part of the review in https://github.com/openjournals/joss-reviews/issues/1942

The README.md file claims to be markdown formatted (ending with .md) but it is definitely not as you cannot really read it easily on https://github.com/benjaminbolling/DynaGUI. This is not a blocking issue as the format of the installation instructions, etc. is not part of the JOSS requirements, but I strongly recommend to fix this. If you have strong feelings about the format of this file @benjaminbolling, you should at least rename it to README.txt.

Here is some guide how to make a proper README file: https://github.com/18F/open-source-guide/blob/18f-pages/pages/making-readmes-readable.md

benjaminbolling commented 4 years ago

The README file has been updated. @Chilipp Since you opened this issue, I leave it up to you to decide if this issue is to be considered as closed or not.

Chilipp commented 4 years ago

Thanks @benjaminbolling!