search

timeseries / qstudio

qStudio - Free SQL Analysis Tool
https://www.timestored.com/qstudio/
Apache License 2.0
416 stars 17 forks source link

Update docs for qStudio #63

Closed richb-hanover closed 3 weeks ago

richb-hanover commented 3 weeks ago

I offer these changes to the qStudio README and other documentation based on what I've learned while horsing around.

  1. Split CHANGELOG from README. Having a separate changelog makes it easy to add info to the CHANGELOG without triggering changes to the README. (People check the README continually, since it's the main page of the repo.)
  2. The CHANGELOG.md file follows the spirit of https://common-changelog.org/. It makes it easy for the reader to see the dates of particular releases, and everything that changed. The "Unreleased" section permits the developer to enter changes as they are committed. When it comes time to create a release, "all you have to do" is move the bullet points from the Unreleased section.
  3. I added a TROUBLESHOOTING.md file that gives the java -jar qstudio.jar hint. This page can be home to any other clever tricks that people should know about.
  4. I tweaked the brief description of qStudio on the CHANGELOG page. See if you like it...

Thanks!

ryanhamilton commented 3 weeks ago

Good idea. Thanks @richb-hanover