Skip to content

Commit b896185

Browse files
docs: add quality of life changes
1 parent 8790352 commit b896185

File tree

2 files changed

+20
-7
lines changed

2 files changed

+20
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# CellularAutomata.jl
2-
31
<p align="center">
42
<img width="400px" src="docs/src/assets/logo.svg"/>
53
</p>
64

5+
<div align="center">
6+
77
| **Documentation** | **Build Status** | **Julia** | **Testing** | **DOI** |
88
|:-----------------:|:----------------:|:---------:|:-----------:|:-------:|
99
| [![docs][docs-img]][docs-url] | [![CI][ci-img]][ci-url] [![codecov][cc-img]][cc-url] | [![Julia][julia-img]][julia-url] [![Code Style: Blue][style-img]][style-url] | [![Aqua QA][aqua-img]][aqua-url] [![JET][jet-img]][jet-url] | [![DOI][doi-img]][doi-url]
@@ -32,18 +32,27 @@
3232
[jet-img]: https://img.shields.io/badge/%E2%9C%88%EF%B8%8F%20tested%20with%20-%20JET.jl%20-%20red
3333
[jet-url]: https://github.com/aviatesk/JET.jl
3434

35+
</div>
36+
37+
<div align="center">
38+
<h2>CellularAutomata.jl</h2>
39+
</div>
40+
41+
CellularAutomata.jl offers lightweight and ready to use implementations of
42+
cellular automata, one and two dimensional.
43+
3544
## Installation
36-
CellularAutomata.jl is registered on the general registry. For the installation follow:
45+
CellularAutomata.jl is registered on the general registry. For the installation use either of:
3746

3847
```julia
3948
julia> using Pkg
4049
julia> Pkg.add("CellularAutomata")
4150
```
42-
or, if you prefer:
51+
or, on the REPL:
4352

44-
```julia
45-
julia> using Pkg
46-
julia> Pkg.add("https://github.com/MartinuzziFrancesco/CellularAutomata.jl")
53+
```julia_repl
54+
julia> ] # actually press closed square brackets
55+
pkg> add CellularAutomata
4756
```
4857

4958
## Discrete Cellular Automata

docs/make.jl

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ makedocs(;
77
clean=true,
88
doctest=true,
99
linkcheck=true,
10+
format=Documenter.HTML(;
11+
assets=["assets/favicon.ico"],
12+
canonical="https://MartinuzziFrancesco.github.io/CellularAutomata.jl",
13+
),
1014
warnonly=[:missing_docs],
1115
pages=pages,
1216
)

0 commit comments

Comments
 (0)