Minor Comments for the JOSS Review

Hello, @dtkerns!

I am currently reviewing your submission to JOSS, in issue openjournals/joss-reviews#6111. For that, I am using an ubuntu:latest docker image.

So far, I have found these small issues:

I find odd the organization of the information: we have two readme files which differ only by their extension. One contains the usual information: the JOSS required statement of need, installation, dependencies, example, and how to contribute; the other contains information on how to utilize the software. I would suggest to merge them into a single e readme or rename the readme.txt file to something else.
the dependencies section of d2 is rather confusing: at first glance I thought that opt was an optional dependency. I would suggest to make it clearer, like "d2 requires an LLVM compiler and opt".
have you tested with any other LLVM compiler? Or just clang? If the latter is the case, I would also explicitly mention that you have only tested with clang.
a couple of little typos in ./readme.md, line 26, it says "contrubute" instead of contribute. In line 9, "Additionaly" instead of additionally.

I will continue to comment here as I progress in the review.

Hello, thank you for reviewing my submission and your initial feedback. I believe I've addressed all the issues you've mentioned. Let me know if you find others or if I missed something.

On Sat, Mar 2, 2024 at 4:13 PM Manuel G. Marciani @.***> wrote:

Hello, @dtkerns https://github.com/dtkerns!

I am currently reviewing your submission to JOSS, in issue openjournals/joss-reviews#6111 https://github.com/openjournals/joss-reviews/issues/6111. For that, I am using an ubuntu:latest docker image.

So far, I have found these small issues:

I find odd the organization of the information: we have two readme files which differ only by their extension. One contains the usual information: the JOSS required statement of need, installation, dependencies, example, and how to contribute; the other contains information on how to utilize the software. I would suggest to merge them into a single e readme or rename the readme.txt file to something else.

the dependencies section of d2 is rather confusing: at first glance I thought that opt was an optional dependency. I would suggest to make it clearer, like "d2 requires an LLVM compiler and opt".

have you tested with any other LLVM compiler? Or just clang? If the latter is the case, I would also explicitly mention that you have only tested with clang.

a couple of little typos in ./readme.md, line 26, it says "contrubute" instead of contribute. In line 9, "Additionaly" instead of additionally.

I will continue to comment here as I progress in the review.

— Reply to this email directly, view it on GitHub https://github.com/dtkerns/d2/issues/4, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADVJRKELUGDA25UELLOSSW3YWJMK5AVCNFSM6AAAAABEDOF3MCVHI2DSMVQWIX3LMV43ASLTON2WKOZSGE3DKMBSGI2TKMY . You are receiving this because you were mentioned.Message ID: @.***>

dtkerns / d2

Minor Comments for the JOSS Review #4