From abc5bd67a99f9265fa72bbc08f2756a8d498be13 Mon Sep 17 00:00:00 2001 From: Silas Kraume Date: Fri, 5 Jan 2024 00:36:48 +0100 Subject: [PATCH] make anchor links pypi compatible --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index afdc0f15..9bbcfbef 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,8 @@ +
+ ## About The Project [![Unittests]](https://github.com/SilenZcience/cat_win/actions/workflows/unit_test.yml) @@ -75,19 +77,26 @@ Additionally it includes the feature to strip and reverse the content of any giv It is of course possible to use cat_win on Linux or MacOS, aswell as Windows! +
+ ### Made With [![MadeWith-Python]](https://www.python.org/) [![Python][Python-Version]](https://www.python.org/)

(back to top)

+
## Getting Started +
+ ### Prerequisites - Using cat_win as a Python-Package demands a Python-Interpreter (>= 3.7). - Using cat_win as an Executable (Windows only!) demands no prerequisites, hereby the stand-alone executables `catw.exe` (& `cats.exe`) are sufficient. +
+ ### Installation [![Version][CurrentVersion]](https://pypi.org/project/cat-win/) @@ -119,6 +128,7 @@ which can also be installed after the fact to patch the problem. > You can verify the creation of catw.exe yourself by reading the [source code](https://github.com/SilenZcience/cat_win/blob/main/cat_win/cat.py), checking the [origin](https://github.com/SilenZcience/cat_win/tree/main/bin) of the file and validating the corresponding [workflow](https://github.com/SilenZcience/cat_win/blob/main/.github/workflows/build_executable.yml) used.

(back to top)

+
## Usage @@ -137,6 +147,8 @@ cats --help A detailed Documentation of all **Parameters** has moved to another File. Read about specific **Arguments & Options** [here](https://github.com/SilenZcience/cat_win/blob/main/ARGUMENTS.md). +
+ ### Examples
@@ -182,15 +194,20 @@ $ cats --eval --dec -nl ```

(back to top)

+
## Changelog Take a look at the [Changelog](https://github.com/SilenZcience/cat_win/blob/main/CHANGELOG.md) file. +
+ ## License This project is licensed under the MIT License - see the [LICENSE](https://github.com/SilenZcience/cat_win/blob/main/LICENSE) file for details +
+ ## Contact > **SilenZcience**