From 6057524949424ac91984cb9a68afae4463e721c8 Mon Sep 17 00:00:00 2001 From: Takafumi Arakaki Date: Thu, 17 Oct 2019 17:05:24 -0700 Subject: [PATCH 1/3] Add a short description in README --- README.md | 20 +++++++++++++++++++- src/ProgressLogging.jl | 3 +++ 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fa028bf..8df6e56 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,25 @@ -# ProgressLogging +# ProgressLogging: a Logging-based progress bar frontend [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://junolab.github.io/ProgressLogging.jl/stable) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://junolab.github.io/ProgressLogging.jl/dev) [![Build Status](https://travis-ci.com/JunoLab/ProgressLogging.jl.svg?branch=master)](https://travis-ci.com/JunoLab/ProgressLogging.jl) [![Codecov](https://codecov.io/gh/JunoLab/ProgressLogging.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JunoLab/ProgressLogging.jl) [![Coveralls](https://coveralls.io/repos/github/JunoLab/ProgressLogging.jl/badge.svg?branch=master)](https://coveralls.io/github/JunoLab/ProgressLogging.jl?branch=master) + +ProgressLogging.jl is a progress bar _frontend_. It can be used to +report progress of a loop/loops with time-consuming body: + +```julia +julia> using ProgressLogging + +julia> @progress for i in 1:10 + sleep(0.1) + end +``` + +This package is a _frontend_ in the sense using this package alone +does not show any progress bars. You need to use one of the backends +to view the progress. + +* [Juno](https://junolab.org/) +* [ProgressMeterLogging.jl](https://github.com/tkf/ProgressMeterLogging.jl) diff --git a/src/ProgressLogging.jl b/src/ProgressLogging.jl index 1ce7690..fba4c75 100644 --- a/src/ProgressLogging.jl +++ b/src/ProgressLogging.jl @@ -1,5 +1,8 @@ module ProgressLogging +# Use README as the docstring of the module: +@doc read(joinpath(dirname(@__DIR__), "README.md"), String) ProgressLogging + export @progress, @withprogress, @logprogress using Logging: Logging, @logmsg, LogLevel From 6e5319f450cef8bd6c8846e18e214e367fccda99 Mon Sep 17 00:00:00 2001 From: Takafumi Arakaki Date: Fri, 18 Oct 2019 18:44:44 -0700 Subject: [PATCH 2/3] Use "progress logs"/"progress monitors" instead of frontend/backend --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8df6e56..7cf3053 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# ProgressLogging: a Logging-based progress bar frontend +# ProgressLogging: a package for defining progress logs [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://junolab.github.io/ProgressLogging.jl/stable) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://junolab.github.io/ProgressLogging.jl/dev) @@ -6,8 +6,8 @@ [![Codecov](https://codecov.io/gh/JunoLab/ProgressLogging.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JunoLab/ProgressLogging.jl) [![Coveralls](https://coveralls.io/repos/github/JunoLab/ProgressLogging.jl/badge.svg?branch=master)](https://coveralls.io/github/JunoLab/ProgressLogging.jl?branch=master) -ProgressLogging.jl is a progress bar _frontend_. It can be used to -report progress of a loop/loops with time-consuming body: +ProgressLogging.jl is a package for defining _progress logs_. It can +be used to report progress of a loop/loops with time-consuming body: ```julia julia> using ProgressLogging @@ -17,9 +17,9 @@ julia> @progress for i in 1:10 end ``` -This package is a _frontend_ in the sense using this package alone -does not show any progress bars. You need to use one of the backends -to view the progress. +This package does not contain any _progress monitors_ for visualizing +the progress of the program. You need to install a package supporting +progress logs created by ProgressLogging.jl API. For example: * [Juno](https://junolab.org/) * [ProgressMeterLogging.jl](https://github.com/tkf/ProgressMeterLogging.jl) From 738e04f09c04e4bf9f1a4c70d5f4a21b8d78ff72 Mon Sep 17 00:00:00 2001 From: Takafumi Arakaki Date: Mon, 21 Oct 2019 11:22:28 -0700 Subject: [PATCH 3/3] Rename: ProgressMeterLogging -> ConsoleProgressMonitor --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7cf3053..9953bdd 100644 --- a/README.md +++ b/README.md @@ -22,4 +22,4 @@ the progress of the program. You need to install a package supporting progress logs created by ProgressLogging.jl API. For example: * [Juno](https://junolab.org/) -* [ProgressMeterLogging.jl](https://github.com/tkf/ProgressMeterLogging.jl) +* [ConsoleProgressMonitor.jl](https://github.com/tkf/ConsoleProgressMonitor.jl)