search

TheCase / IPMIView.app

MacOS App wrapper for Supermicro's IPMIView/iKVM java app
https://github.com/TheCase/IPMIView.app/wiki
203 stars 43 forks source link

Horrible documentation! #9

Closed Joebeazelman closed 4 years ago

Joebeazelman commented 4 years ago

Your installation instructions just sucks! Just two measly minutes of your time would eliminate a good deal of the issues created here. You instruct the user to install the latest release from supermicro's FTP site and then instruct them to execute a bunch of shell scripts. What folder are they supposed to be in? Where do they download IPMIView to? I am assuming the shell scripts create the App bundle and the user is supposed to unarchive the downloaded IPMIView inside it.

If you have a problem writing in the English language, you might want to just have your script do the right thing. How can you even reveal your face on your profile after putting out such mediocrity?

TheCase commented 4 years ago

https://www.dictionary.com/browse/you-can-catch-more-flies-with-honey-than-with-vinegar

  1. Open Source Software: I decided to share this code that I developed on my own free time. I don't get paid to work on it. I shared it to be nice to others that might find it useful. I would hope you would treat me nicely for sharing it with you. If you have an issue with open source software on GitHub, it is possible to create an issue without downright insulting the author.

  2. Download directory: as clearly seen in the shell script, it is the Downloads folder in your home directory~/Downloads. I have made this crystal clear in the updated documentation.

  3. Function: it is indeed a shell script that performs the functions necessary to turn the SuperMicro's Linux package into an Application Bundle that will run on your Mac. The script takes care of the unarchiving. That's why I didn't mention it in the README. If you follow the instructions as written, it works. If you still have issues, please file a proper issue report with details about what you expect the software to do and clearly document where it is failing. Cutting and pasting the actual error output into the issue is extremely helpful.

  4. Quality: If you think can do a better job, please fork this repository and go for it.

  5. Have a nice day!

TheCase commented 4 years ago

updated documentation a41bc50ad5489c041b48c2a558147817368e0e1f

TheCase commented 4 years ago

Thank you for the apology. Given the polarization between your two comments, I suggest to stay away from the keyboard after drinking and/or seek some professional help.

weitzhandler commented 4 years ago

Given the polarization between your two comments

He deleted the apology...

TheCase commented 4 years ago

Oh geez. Whatever.