Skip to content

Commit 1905605

Browse files
committed
Added linked to shortcutpymol.py project in README.md.
1 parent 81e5a0e commit 1905605

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

README.md

+17-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# pymolsnips: PyMOL Script Writing with Code Templates
1+
# pymolsnips: Templates for writing PyMOL scripts.
22

33
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
44

@@ -23,7 +23,8 @@ 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.
26+
If you are not ready to write PyMOL scripts, please consider using [PyMOL shortcuts](https://github.com/MooersLab/pymolshortcuts) to enhance your productivity in PyMOL interactive sessions.
27+
For example, the above ambient occlussion effect can be invoked at anytime by entering `AO` at the PyMOL prompt, if the pymolshortcuts.py file has been loaded.
2728

2829
## Application Description
2930

@@ -60,6 +61,7 @@ Some of the snippets have Python3 code.
6061
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.
6162
This often merely involves replacing print statements in Python2 with print() functions in Python3.
6263
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.
64+
6365
[Return to Table of Contents](#table-of-contents)
6466

6567

@@ -73,6 +75,7 @@ Download all of the libraries by using the command `git clone https://github.com
7375
Alternatively, you download all of the libraries as a zip file by clicking on the green **code** button above.
7476

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

7881

@@ -81,7 +84,8 @@ See the [GitHub Page](https://mooerslab.github.io/pymolsnips/) for installation
8184

8285
The snippet libraries are independent of PyMOL.
8386
No modification of PyMOL is required.
84-
The configuring of text editors is found on the [GitHub Page](https://mooerslab.github.io/pymolsnips/) .
87+
The configuring of text editors is found on the [GitHub Page](https://mooerslab.github.io/pymolsnips/).
88+
8589
[Return to Table of Contents](#table-of-contents)
8690

8791

@@ -91,11 +95,14 @@ The configuring of text editors is found on the [GitHub Page](https://mooerslab.
9195
Examples of the snippets in use in various editors are found in the animated gifs on the [GitHub Page](https://mooerslab.github.io/pymolsnips/).
9296
These gifs convey the essential knowledge in seconds.
9397

98+
[Return to Table of Contents](#table-of-contents)
99+
94100

95101

96102
<a id="testing"><h2>Testing</h2></a>
97103

98104
Try the **ao** snippet. You should get a result similar to the one should in the demo above.
105+
99106
[Return to Table of Contents](#table-of-contents)
100107

101108

@@ -106,11 +113,14 @@ Alternatiley, you can send [e-mail](#contact-information) to me.
106113

107114
Questions about PyMOL should be directed to the [PyMOL Mailing List](https://pymolwiki.org/index.php/PyMOL_mailing_list).
108115

116+
[Return to Table of Contents](#table-of-contents)
117+
109118

110119
<a id="bugreports"><h2>Bug reports</h2></a>
111120

112121
Use the **Issues tab** above to report bugs or send [e-mail](#contact-information) to me.
113-
Refer bugs in the text editors to the developers of the text editors.
122+
Refer bugs in the text editors to the developers of the text editors.
123+
114124
[Return to Table of Contents](#table-of-contents)
115125

116126

@@ -119,10 +129,13 @@ Refer bugs in the text editors to the developers of the text editors.
119129
We use the permissive MIT license.
120130
The license information for this project is found in the License.txt file above.
121131

132+
[Return to Table of Contents](#table-of-contents)
133+
122134

123135
<a id="contact-information"><h2>Contact Information</h2></a>
124136

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

128141

@@ -182,5 +195,4 @@ For ENDNOTE library.enw file.
182195
%I Wiley Online Library
183196
```
184197

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

0 commit comments

Comments
 (0)