Skip to content

Commit

Permalink
Minor fixes to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
iSoron committed Nov 16, 2020
1 parent dbd4d78 commit 23de034
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@

If you use UnitCommitment.jl in your research, we request that you cite the package as follows:

* Alinson S. Xavier, Feng Qiu, "UnitCommitment.jl: A Julia/JuMP Optimization Package for Security-Constrained Unit Commitment". Zenodo (2020). [DOI: 10.5281/zenodo.4269874](https://doi.org/10.5281/zenodo.4269874).
* **Alinson S. Xavier, Feng Qiu**. "UnitCommitment.jl: A Julia/JuMP Optimization Package for Security-Constrained Unit Commitment". Zenodo (2020). [DOI: 10.5281/zenodo.4269874](https://doi.org/10.5281/zenodo.4269874).

If you make use of the provided instances files, we request that you additionally cite the original sources, as described in the [instances page](https://anl-ceeesa.github.io/UnitCommitment.jl/0.1/instances/).

Expand Down
4 changes: 2 additions & 2 deletions src/docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
UnitCommitment.jl was tested and developed with [Julia 1.5](https://julialang.org/). To install Julia, please follow the [installation guide on the official Julia website](https://julialang.org/downloads/platform.html). To install UnitCommitment.jl, run the Julia interpreter, type `]` to open the package manager, then type:

```text
pkg> add https://github.com/ANL-CEEESA/UnitCommitment.jl.git
pkg> add UnitCommitment
```

To test that the package has been correctly installed, run:
Expand Down Expand Up @@ -50,7 +50,7 @@ As described in the [Instances page](instances.md), UnitCommitment.jl contains a

```julia
using UnitCommitment
instance = UnitCommitment.read_benchmark("matpower/case3375wp/2017-01-01")
instance = UnitCommitment.read_benchmark("matpower/case3375wp/2017-02-01")
```

## 3. Advanced usage
Expand Down

2 comments on commit 23de034

@iSoron
Copy link
Member Author

@iSoron iSoron commented on 23de034 Nov 16, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/24734

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.1 -m "<description of version>" 23de0345b36cf859e13164ee48a2b54219be5aba
git push origin v0.1.1

Please sign in to comment.