search

rwanwork / QScores-Archiver

Quality Scores Archiver
GNU Lesser General Public License v2.1
0 stars 2 forks source link

Improve documentation #7

Open rwanwork opened 4 months ago

rwanwork commented 4 months ago

Any corrections or improvements to any of the project's documentation would be appreciated.

This might include (but not limited to): typos, phrases that are wrong, and/or phrases that would improve understanding.

Both inline comments and the project's meta information (i.e., the README.md) can be considered.

Th0ught09 commented 1 month ago

I've started adding more robust unix commands on my fork, as well as changing some things (install location to /tmp as it is deleted on reboot as opposed to ~/tmp etc.) This is only to the README.md so far so I wouldn't want to deter any others as I've have not covered c++ in my course but could I be assigned this so long?

rwanwork commented 1 month ago

I don't mind assigning this to you, but CMake allows the user to choose the installation location at the command-line. ~/tmp was just an example -- the user is free to choose anything. I wouldn't be in favour of replacing it with /tmp in the documentation. Not because your argument is wrong...you are right! But it's just an example in the documentation and anything can be chosen.

I would suggest focussing on things that would improve a user's understanding (ie. My mistakes). And not change things based on opinion, because you and I probably have different opinions.