Skip to content

Add a short description in README #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 21, 2019
Merged

Add a short description in README #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6057524
Add a short description in README
tkf Oct 18, 2019
6e5319f
Use "progress logs"/"progress monitors" instead of frontend/backend
tkf Oct 19, 2019
738e04f
Rename: ProgressMeterLogging -> ConsoleProgressMonitor
tkf Oct 21, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,25 @@
# ProgressLogging
# 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)
[![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 package for defining _progress logs_. 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 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/)
* [ConsoleProgressMonitor.jl](https://github.com/tkf/ConsoleProgressMonitor.jl)
3 changes: 3 additions & 0 deletions src/ProgressLogging.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down