Skip to content

Commit

Permalink
Add more badges, more cosmetics
Browse files Browse the repository at this point in the history
  • Loading branch information
oir committed Dec 18, 2023
1 parent 3b7adbc commit 3f314a9
Show file tree
Hide file tree
Showing 5 changed files with 237 additions and 11 deletions.
16 changes: 11 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -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)

<img src="img/C++.svg" height="22"> [![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) <br/>
<img src="img/python.svg" height="22"> [![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)


---

Expand Down Expand Up @@ -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.

Expand Down
1 change: 0 additions & 1 deletion docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@

* [Home](README.md)


__API__
* [Namespaces](api/Namespaces/)
* [Classes](api/Classes/)
223 changes: 223 additions & 0 deletions docs/img/C++.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/img/python.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 2 additions & 5 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@
<meta name="description" content="Description">
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css">
<link rel="preconnect" href="https://fonts.googleapis.com" />
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
<link href="https://fonts.googleapis.com/css2?family=Fira+Mono&display=swap" rel="stylesheet" />
<link href="https://fonts.cdnfonts.com/css/sf-mono" rel="stylesheet">
</head>
<body>
<div id="app"></div>
Expand Down Expand Up @@ -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;
Expand Down

0 comments on commit 3f314a9

Please sign in to comment.