intersystems-community / cache-tort-git

Access to Tortoise Git interface from Caché Studio
https://github.com/intersystems-ru/cache-tort-git/wiki
MIT License
31 stars 20 forks source link

Updates to README.md #48

Closed lanhamm closed 6 years ago

lanhamm commented 7 years ago

Updates for readability and clarity

I had trouble following some of the directions as they were written, so my edits are to try to make them more clear for the next people who try to use them.

lanhamm commented 7 years ago

Thank you for this plug-in!

eduard93 commented 7 years ago

Hello. Thank you for your contribution!

  1. Please correct the numbering in the README. Here's screenshot off your pull: image

Old numbering (everywhere) was 1,2,3... now its (also everywhere) 1,1,1...

  1. In the sectionInstallation in Caché:
    • CACHELIB namespace should be CACHELIB database
    • %CACHELIB database should be CACHELIB database
    • %CACHELIB should be CACHELIB
lanhamm commented 7 years ago

Hi - you're actually not using markdown appropriately by numbering things 1, 2, 3. Look at the preview and you'll see that it looks correct when you use 1, 1, 1. See documentation here.

I made the CACHELIB changes.

Thanks, Michael

eduard93 commented 7 years ago

Didn't knew about numbering by 1,1,1. Still 1,2,3 produces the same result but looks nicer in my opinion. @adaptun?

eduard93 commented 7 years ago

Also CACHELIB namespace should be CACHELIB database. There's no CACHELIB namespace.