docs: CMI name update and installation update #65
Conversation
sbillinge
left a comment
sbillinge
left a comment
There was a problem hiding this comment.
I think it should be everywhere lower-case (diffpy.cmi) but if you can figure out a way of defining an alias, kind of like we do in our latex papers, we could do the same as we do there and make it lower-case but render program names as small-cap. If you can figure out how to do that in RST, and make a project to do that for all the software programs, this will become easier to maintain in the future. Of course we don't want it to look like that in urls, code-snippets etc. Please see if there is a way to do it.
README.md
Outdated
| - [Adding Citations](#adding-citations) | ||
| - [Adding Publications that Describe a DiffPy Project (the "Reference" Section)](#reference-section-1) | ||
| - [Adding Other Publications (the "Publication Using DiffPy-CMI" Section)](#reference-section-2) | ||
| - [Adding Other Publications (the "Publication Using DiffPy.CMI" Section)](#reference-section-2) |
There was a problem hiding this comment.
I think it should be everywhere diffpy.cmi (lower-case) as that is its defacto name.
|
@sbillinge There is a straightforward way to do it for rst files which I've included in my last commit. But non rst files (like html and txt) require a different method which is a bit more complex and involved. You can define the name in css for html and wrap it everywhere it appears in the text. For txt, it doesn't seem to really be possible. Not sure if all of this would really make maintenance easier in the future. |
2 participants
I went through and manually changed the name from diffpy-cmi to diffpy.cmi. I've also updated installation instructions to match the current docs. documentation built successfully on local