diff --git a/README.md b/README.md index a54a2cca59..4ccc248e54 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -# Bats-core: Bash Automated Testing System - [![Latest release](https://img.shields.io/github/release/bats-core/bats-core.svg)](https://github.com/bats-core/bats-core/releases/latest) [![npm package](https://img.shields.io/npm/v/bats.svg)](https://www.npmjs.com/package/bats) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/bats-core/bats-core/blob/master/LICENSE.md) @@ -8,6 +6,15 @@ [![Join the chat in bats-core/bats-core on gitter](https://badges.gitter.im/bats-core/bats-core.svg)][gitter] +
+ + + + +
+ +# Bats-core: Bash Automated Testing System + Bats is a [TAP](https://testanything.org/)-compliant testing framework for Bash 3.2 or above. It provides a simple way to verify that the UNIX programs you write behave as expected. @@ -114,7 +121,9 @@ This [bats-core](https://github.com/bats-core/bats-core) repo is now the communi ## Copyright -© 2017-2023 bats-core organization +The Bats Logo was created by [Vukory](https://www.artstation.com/vukory) ([Github](https://github.com/vukory)) and sponsored by [SethFalco](https://github.com/SethFalco). If you want to use our logo, have a look at our [guidelines](./docs/source/assets/README.md#Usage-Guide-for-Third-Parties). + +© 2017-2024 bats-core organization © 2011-2016 Sam Stephenson diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 27c565b218..057c614d7d 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -39,6 +39,7 @@ The format is based on [Keep a Changelog][kac] and this project adheres to * update Arch Linux package URL in installation.rst (#821) * rename bash-bats to bats for Arch Linux in installation.rst (#836) * fix FAQ entry about setup-/teardown_suite, as they are available now (#861) +* added logo (#881) ## [1.10.0] - 2023-07-15 diff --git a/docs/source/assets/README.md b/docs/source/assets/README.md new file mode 100644 index 0000000000..cfa3904cb8 --- /dev/null +++ b/docs/source/assets/README.md @@ -0,0 +1,24 @@ +# Our Logo + +
+ + + + +
+ +## Usage Guide for Third Parties + +There may be cases where you want to use our logo. Please follow these rules: + +**DO** use our logo as a part of thumbnails, banners/images in articles, or on a README in reference to the this project. + +**DO** use our logo to relate resources back to the Bats project, like file associations or links to the project page. + +**DO NOT** use our logo as the face of a third-party tool or extension that is not affiliated with the Bats project or Bats maintainers. + +If in doubt, ask if your intended usecase is approved. + +## Credits + +The Bats Logo was created by [Vukory](https://www.artstation.com/vukory) ([Github](https://github.com/vukory)) and sponsored by [SethFalco](https://github.com/SethFalco). diff --git a/docs/source/assets/dark_mode_bat.svg b/docs/source/assets/dark_mode_bat.svg new file mode 100644 index 0000000000..1e70621efe --- /dev/null +++ b/docs/source/assets/dark_mode_bat.svg @@ -0,0 +1,55 @@ + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/source/assets/dark_mode_cube.svg b/docs/source/assets/dark_mode_cube.svg new file mode 100644 index 0000000000..2d324ae940 --- /dev/null +++ b/docs/source/assets/dark_mode_cube.svg @@ -0,0 +1,98 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/source/assets/dark_mode_wordmark_lowercase.svg b/docs/source/assets/dark_mode_wordmark_lowercase.svg new file mode 100644 index 0000000000..24df01984c --- /dev/null +++ b/docs/source/assets/dark_mode_wordmark_lowercase.svg @@ -0,0 +1,75 @@ + + + + + + + + + + + + + + + + + + + diff --git a/docs/source/assets/dark_mode_wordmark_uppercase.svg b/docs/source/assets/dark_mode_wordmark_uppercase.svg new file mode 100644 index 0000000000..c2364bd4ec --- /dev/null +++ b/docs/source/assets/dark_mode_wordmark_uppercase.svg @@ -0,0 +1,80 @@ + + + + + + + + + + + + + + + + + + + diff --git a/docs/source/assets/light_mode_bat.svg b/docs/source/assets/light_mode_bat.svg new file mode 100644 index 0000000000..915e447c88 --- /dev/null +++ b/docs/source/assets/light_mode_bat.svg @@ -0,0 +1,99 @@ + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/source/assets/light_mode_cube.svg b/docs/source/assets/light_mode_cube.svg new file mode 100644 index 0000000000..d4125ab334 --- /dev/null +++ b/docs/source/assets/light_mode_cube.svg @@ -0,0 +1,90 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/source/assets/light_mode_wordmark_lowercase.svg b/docs/source/assets/light_mode_wordmark_lowercase.svg new file mode 100644 index 0000000000..8874ddcc82 --- /dev/null +++ b/docs/source/assets/light_mode_wordmark_lowercase.svg @@ -0,0 +1,79 @@ + + + + + + + + + + + + + + + + + + + diff --git a/docs/source/assets/light_mode_wordmark_uppercase.svg b/docs/source/assets/light_mode_wordmark_uppercase.svg new file mode 100644 index 0000000000..b694f77b7f --- /dev/null +++ b/docs/source/assets/light_mode_wordmark_uppercase.svg @@ -0,0 +1,48 @@ + + + + + + + + + + + + + + + + + + diff --git a/docs/source/conf.py b/docs/source/conf.py index a23e4190de..4c41910935 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -62,7 +62,8 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ['_static', 'assets'] +html_logo = "assets/light_mode_cube.svg" #man_pages = [ ('man.1', 'bats', 'bats documentation', ['bats-core Contributors'], 1)]