Skip to content

Commit 20044b9

Browse files
authored
Tinker with README (#13)
* Update README * Mention General registry in install instructions
1 parent 7ab5917 commit 20044b9

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,20 @@
44
This package is a Julia complement to [LyoPRONTO](https://github.com/LyoHUB/LyoPronto), an open source Python package.
55
It has some overlapping functionality with LyoPRONTO, especially simulation of primary drying for conventional lyophilization.
66
LyoPRONTO (the Python version) also has functionality for generating a design space, estimating time to freeze, and picking optimal drying conditions.
7-
On the other hand, this package has much more advanced utilities for fitting empirical parameters (such as $R_p$ and $K_v$) to experimental data.
7+
On the other hand, this package has much more advanced utilities for fitting empirical parameters (such as $R_p$ and $K_v$) to experimental data.
8+
This package also provides that fitting functionality for a model applicable to microwave-assisted lyophilization.
89

910
## Installation
1011

11-
From the Julia REPL's Pkg mode (open a REPL and type `]` so that the prompt turns blue), add this package as a Git repo:
12+
From the Julia REPL's Pkg mode (open a REPL and type `]` so that the prompt turns blue), add this package from the General registry with:
1213
```
13-
add https://github.com/LyoHUB/LyoPronto.jl.git
14+
add LyoPronto
1415
```
1516

17+
1618
## Documentation
1719

18-
The "badge" up above is a link to the documentation.
20+
The "badge" up above is a link to the documentation, which is [also here](https://lyohub.github.io/LyoPronto.jl/).
1921

2022
## Versioning
2123

@@ -28,7 +30,7 @@ This work was supported in part by funding for NIIMBL project PC4.1-307 .
2830

2931
## License
3032

31-
None yet. My intentions are to use the MIT license once this has been published in a scientific journal.
33+
MIT License; see `LICENSE` file.
3234

3335
# Example usage
3436

0 commit comments

Comments
 (0)