Skip to content

Commit 81e5a0e

Browse files
committed
Testing change in section links in README.md.
1 parent e67d7e1 commit 81e5a0e

File tree

1 file changed

+31
-15
lines changed

1 file changed

+31
-15
lines changed

README.md

+31-15
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
For more details on installing libraries for specific editors, go to the [GitHub Page](https://mooerslab.github.io/pymolsnips/).
66

7-
## GIF of the application (Demo)
7+
## Animated demo of snippet use in Visual Studio Code
88

99
<p>The animation below demonstrates the use of the <b>ao</b> tab trigger in the text editor <em>Visual Studio Code</em> to insert 16 lines of code for generating the ambient occlusion effect.
1010
Two-levels of cascading menus appear.
@@ -23,6 +23,7 @@ There is not an option in a pulldown menu in PyMOL to make such an image: A scri
2323

2424
This code can be applied to any molecular object in PyMOL's veiwport, not just RNA.
2525

26+
If you are not ready to write PyMOL scripts, please consider using pymol shortcuts to enhance your productivity in PyMOL interactive sessions.
2627

2728
## Application Description
2829

@@ -33,8 +34,7 @@ This page takes several seconds to load due to a large number of animated gifs.
3334
The page has the content of the old *README.md* referred to in the associated manuscript.
3435
The old *README.md* file was moved to the webpage on 25 November 2020.
3536

36-
37-
## Table of Contents
37+
<a id="table-of-contents"><h2>Table of Contents</h2></a>
3838

3939
* [Tech Stack](#technology-stack)
4040
* [Installation](#installation)
@@ -56,39 +56,47 @@ The old *README.md* file was moved to the webpage on 25 November 2020.
5656
| PyMOL 2.4 | Molecular graphics program |
5757
| Python 3.7 | Programming language |
5858

59-
Some of the snips have Python3 code.
60-
If you are using an ancient version of PyMOL that relies on Python2, you can buy a license to the current version of PyMOL, install a free open-source version of PyMOL that depends on Python3 (See the PyMOL Wiki), or you can rewrite the code to be Python2 compliant.
59+
Some of the snippets have Python3 code.
60+
If you are using an ancient version of PyMOL that relies on Python2, you can buy a license to the current version of PyMOL, install a free open-source version of PyMOL that depends on Python3 (See the PyMOL Wiki), or you can rewrite the snippet's code to be Python2 compliant.
61+
This often merely involves replacing print statements in Python2 with print() functions in Python3.
6162
Note that multiple versions of PyMOL can operate side-by-side on a computer: You do not have to delete that ancient version of PyMOL.
63+
[Return to Table of Contents](#table-of-contents)
64+
6265

6366
<a id="installation"><h2>Installation</h2></a>
6467

65-
Unfortunately, GitHub does not yet provide an easy way to download part of repository.
66-
It is easist to download the whole repository, pull out the parts that you need, and delete the rest.
67-
Setting up and maintaining 18 separate repositories was too unwieldly.
68+
Unfortunately, GitHub does not yet provide an easy way to download part of a repository.
69+
It is easier to download the whole repository, pull out the parts that you need, and delete the rest.
70+
Setting up and maintaining 18 separate repositories was too unwieldy.
6871

6972
Download all of the libraries by using the command `git clone https://github.com/MooersLab/pymolsnips.git` in a terminal window if you have *git* installed.
70-
Alternatively you download all of the libraries as a zip file by clicking on the green **code** button above.
73+
Alternatively, you download all of the libraries as a zip file by clicking on the green **code** button above.
7174

7275
See the [GitHub Page](https://mooerslab.github.io/pymolsnips/) for installation instructions for a specific text editor.
76+
[Return to Table of Contents](#table-of-contents)
77+
78+
7379

7480
<a id="configuration-setup"><h2>Configuration Setup</h2></a>
7581

7682
The snippet libraries are independent of PyMOL.
7783
No modification of PyMOL is required.
7884
The configuring of text editors is found on the [GitHub Page](https://mooerslab.github.io/pymolsnips/) .
85+
[Return to Table of Contents](#table-of-contents)
7986

8087

81-
<a id="configuration-setup"><h2>Configuration Setup</h2></a>
88+
89+
<a id="usage"><h2>Usage</h2></a>
8290

8391
Examples of the snippets in use in various editors are found in the animated gifs on the [GitHub Page](https://mooerslab.github.io/pymolsnips/).
8492
These gifs convey the essential knowledge in seconds.
8593

8694

8795

88-
<a id="esting"><h2>Testing</h2></a>
96+
<a id="testing"><h2>Testing</h2></a>
8997

9098
Try the **ao** snippet. You should get a result similar to the one should in the demo above.
91-
99+
[Return to Table of Contents](#table-of-contents)
92100

93101

94102
<a id="requests"><h2>Requests for new snippets and text editors</h2></a>
@@ -103,17 +111,19 @@ Questions about PyMOL should be directed to the [PyMOL Mailing List](https://pym
103111

104112
Use the **Issues tab** above to report bugs or send [e-mail](#contact-information) to me.
105113
Refer bugs in the text editors to the developers of the text editors.
114+
[Return to Table of Contents](#table-of-contents)
106115

107116

108117
<a id="license"><h2>License</h2></a>
109118

110119
We use the permissive MIT license.
111-
This license information for this project is found in the License.txt file above.
120+
The license information for this project is found in the License.txt file above.
112121

113122

114123
<a id="contact-information"><h2>Contact Information</h2></a>
115124

116125
I can be reached via the Issue tab above or via e-mail: `blaine-mooers at ouhsc.edu`.
126+
[Return to Table of Contents](#table-of-contents)
117127

118128

119129
<a id="citation"><h2>Citation</h2></a>
@@ -124,7 +134,11 @@ If you use this library to make figures for publication, please site the followi
124134

125135
Mooers, B. H., & Brown, M. (2020). Templates for Writing PyMOL Scripts. Protein Science. 30 Nov. 10.1002/pro.3997
126136

127-
For BibTex:
137+
OR
138+
139+
Mooers, BHM, Brown, ME. Templates for writing PyMOL scripts. Protein Science. 2020; 1–8. https://doi.org/10.1002/pro.3997
140+
141+
For BibTex library.bib file:
128142

129143
```bibtex
130144
@article{mooers2020templates,
@@ -155,7 +169,7 @@ For BibTex:
155169
}
156170
```
157171

158-
For ENDNOTE
172+
For ENDNOTE library.enw file.
159173

160174
```bash
161175
%0 Journal Article
@@ -168,3 +182,5 @@ For ENDNOTE
168182
%I Wiley Online Library
169183
```
170184

185+
186+
[Return to Table of Contents](#table-of-contents)

0 commit comments

Comments
 (0)