From 5981e92fee80e6e111ad1ab0b3928deb34657d5f Mon Sep 17 00:00:00 2001 From: Arno Strouwen Date: Sat, 27 Aug 2022 06:20:10 +0200 Subject: [PATCH 1/3] badges --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 48a9d464..b165f9c8 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ # JumpProcesses.jl [![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged) -[![Build Status](https://github.com/SciML/JumpProcesses.jl/workflows/CI/badge.svg)](https://github.com/SciML/JumpProcesses.jl/actions?query=workflow%3ACI) -[![Coverage Status](https://coveralls.io/repos/github/SciML/JumpProcesses.jl/badge.svg?branch=master)](https://coveralls.io/github/SciML/JumpProcesses.jl?branch=master) -[![codecov.io](https://codecov.io/gh/SciML/JumpProcesses.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/SciML/JumpProcesses.jl) [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](http://jump.sciml.ai/stable/) -[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](http://jump.sciml.ai/dev/) +[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/dev/modules/JumpProcesses/) + +[![Coverage Status](https://coveralls.io/repos/github/SciML/JumpProcesses.jl/badge.svg?branch=master)](https://coveralls.io/github/SciML/JumpProcesses.jl?branch=master) +[![codecov](https://codecov.io/gh/SciML/JumpProcesses.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/SciML/JumpProcesses.jl) +[![Build Status](https://github.com/SciML/JumpProcesses.jl/workflows/CI/badge.svg)](https://github.com/SciML/JumpProcesses.jl/actions?query=workflow%3ACI) + [![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet)](https://github.com/SciML/ColPrac) [![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle) From 8a0028a75fa80dfa4d291a566b451b53228bb055 Mon Sep 17 00:00:00 2001 From: Arno Strouwen Date: Sat, 27 Aug 2022 21:25:54 +0200 Subject: [PATCH 2/3] add reference to dev docs --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b165f9c8..17b57b37 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,10 @@ JumpProcesses is a component package in the [SciML](https://sciml.ai/) ecosystem and one of the core solver libraries included in [DifferentialEquations.jl](https://github.com/JuliaDiffEq/DifferentialEquations.jl). -The documentation includes +For information on using the package, +[see the stable documentation](http://jump.sciml.ai/stable/). Use the +[in-development documentation](http://jump.sciml.ai/dev/) for the version of +the documentation, which contains the unreleased features. This documentation includes - [a tutorial on simulating basic Poisson processes](https://jump.sciml.ai/stable/tutorials/simple_poisson_process/) - [a tutorial and details on using JumpProcesses to simulate jump processes via SSAs (i.e. Gillespie methods)](https://jump.sciml.ai/stable/tutorials/discrete_stochastic_example/), - [a tutorial on simulating jump-diffusion processes](https://jump.sciml.ai/stable/tutorials/jump_diffusion/), From 12ad70a597097e780437c6efad6692dfe831ffe5 Mon Sep 17 00:00:00 2001 From: Sam Isaacson Date: Fri, 2 Sep 2022 11:26:12 -0400 Subject: [PATCH 3/3] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 17b57b37..a33ae886 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,9 @@ and one of the core solver libraries included in For information on using the package, [see the stable documentation](http://jump.sciml.ai/stable/). Use the [in-development documentation](http://jump.sciml.ai/dev/) for the version of -the documentation, which contains the unreleased features. This documentation includes +the documentation, which contains the unreleased features. + +The documentation includes - [a tutorial on simulating basic Poisson processes](https://jump.sciml.ai/stable/tutorials/simple_poisson_process/) - [a tutorial and details on using JumpProcesses to simulate jump processes via SSAs (i.e. Gillespie methods)](https://jump.sciml.ai/stable/tutorials/discrete_stochastic_example/), - [a tutorial on simulating jump-diffusion processes](https://jump.sciml.ai/stable/tutorials/jump_diffusion/),