Update README

ricktu288 · Dec 21, 2024 · 4049e83 · 4049e83
1 parent e4ec2e6
commit 4049e83
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -39,7 +39,7 @@ If you use this project in your research, please cite it using the metadata in t
 
 You can also include the URL https://phydemo.app/ray-optics/ in the citation. The URL will not change in the foreseeable future (at least until 2032).
 
-If you are strict about versioning, you may consider using the latest released version instead of the online version, and replace the project DOI in the citation file above with the versioned DOI. The DOI for the latest `v5.0` release is `10.5281/zenodo.14538565`. See [Run Locally](https://github.com/ricktu288/ray-optics/blob/master/run-locally/README.md#run-the-released-version) for how to run the released version locally.
+If you are strict about versioning, you may consider using the "released" version (which are older) instead of the latest online version, and replace the project DOI in the citation file above with the versioned DOI. The DOI for the latest `v5.0` release is `10.5281/zenodo.14538565`. See [Run Locally](https://github.com/ricktu288/ray-optics/blob/master/run-locally/README.md#run-the-released-version) for how to run the released version locally.
 
 ## Contributing
 

diff --git a/run-locally/README.md b/run-locally/README.md
@@ -30,4 +30,4 @@ Note that if your local version is outdated, and you try to open a scene created
 
 ## Run the released version
 
-This project has DOI on Zenodo, but the versioned DOIs are only available for the released versions. If you are strict about versioning and want to use the exact version of this project associated with a DOI, then instead of downloading the latest deployment, you can download the latest release instead. The latest release `v5.0` is associated with the DOI `10.5281/zenodo.14538565`, and you can download the deployment [here](https://github.com/ricktu288/ray-optics/archive/refs/heads/release/v5.0.zip) and follow the steps above. However, note that there is no special meaning for the "release" compared with regular deployments, and can also become outdated (see above). The only differences are that it has a versioned DOI and does not contain beta features.
+This project has DOI on Zenodo, but the versioned DOIs are only available for the "released" versions, which are archives of some specific older online versions. If you are strict about versioning and want to use the exact version of this project associated with a DOI, then instead of downloading the latest deployment, you can download the latest release instead. The latest release `v5.0` is associated with the DOI `10.5281/zenodo.14538565`, and you can download the deployment [here](https://github.com/ricktu288/ray-optics/archive/refs/heads/release/v5.0.zip) and follow the steps above. However, note that there is no special meaning for the release compared with regular deployments, and can also become outdated (see above). The only differences are that it has a versioned DOI and does not contain beta features.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -30,4 +30,4 @@ Note that if your local version is outdated, and you try to open a scene created

		## Run the released version

		This project has DOI on Zenodo, but the versioned DOIs are only available for the released versions. If you are strict about versioning and want to use the exact version of this project associated with a DOI, then instead of downloading the latest deployment, you can download the latest release instead. The latest release `v5.0` is associated with the DOI `10.5281/zenodo.14538565`, and you can download the deployment [here](https://github.com/ricktu288/ray-optics/archive/refs/heads/release/v5.0.zip) and follow the steps above. However, note that there is no special meaning for the "release" compared with regular deployments, and can also become outdated (see above). The only differences are that it has a versioned DOI and does not contain beta features.
		This project has DOI on Zenodo, but the versioned DOIs are only available for the "released" versions, which are archives of some specific older online versions. If you are strict about versioning and want to use the exact version of this project associated with a DOI, then instead of downloading the latest deployment, you can download the latest release instead. The latest release `v5.0` is associated with the DOI `10.5281/zenodo.14538565`, and you can download the deployment [here](https://github.com/ricktu288/ray-optics/archive/refs/heads/release/v5.0.zip) and follow the steps above. However, note that there is no special meaning for the release compared with regular deployments, and can also become outdated (see above). The only differences are that it has a versioned DOI and does not contain beta features.