Skip to content

Commit f1f2ca5

Browse files
authored
Updating README.md (#3)
Updating PyRosetta download notice and contribution guidelines. @rclune Please feel free to make any additional edits as you see fit.
1 parent aaf9528 commit f1f2ca5

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,8 @@
1-
# tests
2-
various tests for RC infrastructure
1+
# ✨ PyRosetta Extras: a repository for PyRosetta scripts, tools, unit testing, and documentation
2+
> [!IMPORTANT]
3+
> Scripts in this GitHub repository may require download and installation of [PyRosetta software](https://www.pyrosetta.org/downloads) to run properly.
4+
> Downloads of PyRosetta software are provided to academic and non-commercial users under the [PyRosetta Software Non-Commercial License Agreement](https://github.com/RosettaCommons/rosetta/blob/main/LICENSE.PyRosetta.md).
5+
> While scripts in this GitHub repository are made publicly available under the [MIT License](https://github.com/RosettaCommons/pyrosetta-extras/blob/main/LICENSE), the scripts themselves may require download and installation of PyRosetta software to run properly, and therefore use of the scripts for commercial purposes (including fee-for-service work by academic users) may require purchase of a separate license. Please see [here](https://els2.comotion.uw.edu/product/pyrosetta) or email [email protected] for more information.
6+
7+
## ✏️ Contributions:
8+
Please use Rosetta's [Fork-and-PR model](https://github.com/RosettaCommons/rosetta?tab=contributing-ov-file#starting-rosetta-developement) for development. See https://www.rosettacommons.org/docs/latest/internal_documentation/GithubWorkflow for more information about the recommended workflow.

0 commit comments

Comments
 (0)