textbrowser / spot-on

Complexity is beautiful. Anywhere, anyone. AMD, ARM, Alpha, PowerPC, Sparc64, etc. Completed.
https://textbrowser.github.io/spot-on/
Other
72 stars 14 forks source link

No documentation. #9

Closed ghost closed 2 years ago

ghost commented 2 years ago

I cannot find any documentation on Spot-On or Echo anywhere. If it exists, it should be linked prominently from the project website. If it doesn't exist, it should.

textbrowser commented 2 years ago

That's incorrect.

There's a smorgasbord of information in https://github.com/textbrowser/spot-on/tree/master/branches/trunk/Documentation.

:)

ghost commented 2 years ago

That's incorrect.

What's incorrect? I didn't state that there is no documentation, I stated that I couldn't find it.

Don't you agree that the documentation should be linked from the project homepage, and from the github readme?

While we're at it, shouldn't the readme, or the About blurb, contain a summary of what the project even is or does?

textbrowser commented 2 years ago

I do not understand the necessity to endorse public and published projects. The brief summary describes Spot-On. The lengthier description does too. Those who are curious will discover it and those who are not will not. It's a wonderful hobby. It's free. It is documented. For sure.

textbrowser commented 2 years ago

So, the official document is embedded into the application.

textbrowser commented 2 years ago

Revised the README.md file.

https://github.com/textbrowser/spot-on/blob/master/README.md

textbrowser commented 2 years ago

And will include a reference to the Documentation folder on the Web site with the next release.

textbrowser commented 2 years ago

I'm now forced to do all of this work for other projects. :)

textbrowser commented 2 years ago

All done! So.

  1. Documentation links included in README.md and the Web site.
  2. Embedded, live documentation included in the executable.

Thanks.

textbrowser commented 2 years ago

Documentation and release notes living inside the executable! Inside the machine!

Screenshot_20211008_104833