Skip to content

Commit

Permalink
docs: fix the description and add fun additional logos
Browse files Browse the repository at this point in the history
  • Loading branch information
MultifokalHirn committed Dec 21, 2023
1 parent 471d398 commit 6ef785a
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 11 deletions.
29 changes: 18 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,35 @@

<!-- markdownlint-disable -->
*****under construction*****

<p align="center">
<!-- github-banner-start -->
<h1><code>ornaments</code></h1>
<!-- github-banner-end -->
</p>

<!-- markdownlint-restore -->

![GitHub last commit](https://img.shields.io/github/last-commit/MultifokalHirn/ornaments)
[![Tests](https://github.com/MultifokalHirn/ornaments/actions/workflows/python-checks.yaml/badge.svg?branch=main)](https://github.com/MultifokalHirn/ornaments/actions/workflows/python-checks.yaml)
![Coverage](./docs/img/coverage.svg)
![GitHub last commit](https://img.shields.io/github/last-commit/MultifokalHirn/ornaments)

<!-- ![GitHub issues](https://img.shields.io/github/issues/MultifokalHirn/ornaments)
![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/MultifokalHirn/ornaments) -->

***Under construction.***
`ornaments` helps to *future-proofly* document the intent of one's `python` code.

<img align="right" src="./docs/img/ornaments.png" width="100" height="100" >
<img align="left" src="./docs/img/ornaments.png" width="100" height="100" />

`ornaments` helps to *future-proofly* debug and document the intent of one's `python` code. It aims to do so through meaningful `@decorator` functions that help other developers (re-)use, as well as debug, any given code snippet.
It aims to do so through meaningful `@decorator` functions that help other developers understand, (re-)use, and debug your code.

## Contents
<br clear="left"/>

<details>

<summary>Table of Contents</summary>
<summary><h2>Contents</h2></summary>

- [Contents](#contents)
- [Overview](#overview)
- [Why use decorators?](#why-use-decorators)
- [Why decorators?](#why-decorators)
- [Example](#example)
- [Structure](#structure)
- [Addendum](#addendum)
Expand All @@ -43,7 +44,7 @@
- various context-dependend logging functionalities (i.e. execution time)
- *testable* meta information (i.e. deprecation warnings)

### Why use decorators?
### Why decorators?

A `@decorator` 'talks' *about other code* in a way that is <u>understandable for both the human reader *as well as* the interpreter</u>. By being meaningful to both, `@decorator` based documentation can bypass the common disconnect between code comments and reality.

Expand Down Expand Up @@ -71,7 +72,7 @@ ornaments.exceptions.CalledTooOftenError: Function only_once_callable_function h
le_function at 0x10d929120>)
```

<img width="1421" alt="Screenshot 2023-12-21 at 01 48 35" src="https://github.com/MultifokalHirn/ornaments/assets/7870758/8fce40d2-65e4-4c1f-8077-d5eb40641bc5">
<!-- <img width="1421" alt="Screenshot 2023-12-21 at 01 48 35" src="https://github.com/MultifokalHirn/ornaments/assets/7870758/8fce40d2-65e4-4c1f-8077-d5eb40641bc5"> -->

### Structure

Expand Down Expand Up @@ -102,6 +103,12 @@ ornaments/

## Addendum

<img align="center" src="./docs/img/o1.png" width="100" height="100" />
<img align="center" src="./docs/img/o2.png" width="100" height="100" />
<img align="center" src="./docs/img/oran.png" width="100" height="100" />
<br />
<br />

> See [`CONTRIBUTING.md`](./CONTRIBUTING.md) for information on how to setup and contribute to this project.
Author: [`MultifokalHirn`](github.com/MultifokalHirn)
Expand Down
Binary file added docs/img/o1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/o2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/oran.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6ef785a

Please sign in to comment.