diff --git a/docs/README.md b/docs/README.md index 7c8b69b..c4c0acc 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,10 +1,16 @@ ## barkeep -Small C++ header to display async counters and progress bars. Use it by -including `barkeep.h` in your project. +Small, single C++ header to display async animations, counters, and progress bars. +Use it by including `barkeep.h` in your project. +__barkeep__ also has [python bindings](https://pypi.python.org/pypi/barkeep). -[![build](https://github.com/oir/barkeep/actions/workflows/build-test.yml/badge.svg)](https://github.com/oir/barkeep/actions/workflows/build-test.yml) + + [![build](https://github.com/oir/barkeep/actions/workflows/build-test.yml/badge.svg)](https://github.com/oir/barkeep/actions/workflows/build-test.yml) [![Coverage Status](https://coveralls.io/repos/github/oir/barkeep/badge.svg?branch=main)](https://coveralls.io/github/oir/barkeep?branch=main) +![c++17](https://img.shields.io/badge/std-c++17-blue.svg)
+ [![build](https://github.com/oir/barkeep/actions/workflows/build-wheels.yml/badge.svg)](https://github.com/oir/barkeep/actions/workflows/build-wheels.yml) +[![PyPi](https://img.shields.io/badge/python-3.9_|_3.10_|_3.11_|_3.12-blue.svg)](https://pypi.python.org/pypi/barkeep) + --- @@ -127,8 +133,8 @@ including `barkeep.h` in your project. `no_tty` achieves two things: - - Change the delimiter from `\r` to `\n` to avoid wonky looking output in your log files - - Change the default interval to a minute to avoid overwhelming logs (in the example above, we set the interval ourselves explicitly) + - Change the delimiter from `\r` to `\n` to avoid wonky looking output in your log files. + - Change the default interval to a minute to avoid overwhelming logs (in the example above, we set the interval ourselves explicitly). See `demo.cpp` for more examples. diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 4b95ed0..26119f6 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -1,7 +1,6 @@ * [Home](README.md) - __API__ * [Namespaces](api/Namespaces/) * [Classes](api/Classes/) \ No newline at end of file diff --git a/docs/img/C++.svg b/docs/img/C++.svg new file mode 100644 index 0000000..51ae875 --- /dev/null +++ b/docs/img/C++.svg @@ -0,0 +1,223 @@ +C++ diff --git a/docs/img/python.svg b/docs/img/python.svg new file mode 100644 index 0000000..93fb27f --- /dev/null +++ b/docs/img/python.svg @@ -0,0 +1 @@ +Python diff --git a/docs/index.html b/docs/index.html index c605535..8a6c3e8 100644 --- a/docs/index.html +++ b/docs/index.html @@ -7,9 +7,7 @@ - - - +
@@ -50,10 +48,9 @@ :root { --base-font-family : "Helvetica Neue", "Segoe UI", Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; --base-font-size : 16px; + --code-font-family : "SF Mono", Menlo, Consolas, Monaco, Liberation Mono, Lucida Console, monospace; --code-font-size : 13px; - --code-font-family : "Fira Mono"; --code-font-weight : 500; - --code-font-size : 13px; --sidebar-name-font-weight : 400; --sidebar-name-text-align : left;