diff --git a/README.md b/README.md index 9491a18..b20a45b 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,16 @@ If you use TulipaClustering.jl in your work, please cite using the reference given in [CITATION.cff](https://github.com/TulipaEnergy/TulipaClustering.jl/blob/main/CITATION.cff). +## Installation + +```julia-pkg +pkg> add TulipaClustering +``` + +## Bug reports and discussions + +If you think you have found a bug, feel free to open an [issue](https://github.com/TulipaEnergy/TulipaClustering.jl/issues). If you have a general question or idea, start a discussion on the main repo [here](https://github.com/TulipaEnergy/TulipaEnergyModel.jl/discussions). + ## Contributing If you want to make contributions of any kind, please first that a look into our [contributing guide directly on GitHub](docs/src/90-contributing.md) or the [contributing page on the website](https://TulipaEnergy.github.io/TulipaClustering.jl/dev/90-contributing/). diff --git a/docs/Project.toml b/docs/Project.toml index e11b82c..d6ca824 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,6 +1,7 @@ [deps] DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0" Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589" TulipaClustering = "314fac8b-c762-4aa3-9d12-851379729163" [compat] diff --git a/docs/src/95-reference.md b/docs/src/95-reference.md index b4350e4..1313263 100644 --- a/docs/src/95-reference.md +++ b/docs/src/95-reference.md @@ -1,13 +1,5 @@ # [Reference](@id reference) -## Contents - -```@contents -Pages = ["95-reference.md"] -``` - -## Index - ```@index Pages = ["95-reference.md"] ``` diff --git a/docs/src/assets/logo.png b/docs/src/assets/logo.png new file mode 100644 index 0000000..86482c9 Binary files /dev/null and b/docs/src/assets/logo.png differ diff --git a/docs/src/index.md b/docs/src/index.md index 0c2149d..1795370 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -5,9 +5,9 @@ DocTestSetup = quote end ``` -# TulipaClustering +# Welcome -Documentation for [TulipaClustering](https://github.com/TulipaEnergy/TulipaClustering.jl). +Documentation for [TulipaClustering.jl](https://github.com/TulipaEnergy/TulipaClustering.jl). ## Contributors