Skip to content

Commit

Permalink
Convert readme to markdown (#68)
Browse files Browse the repository at this point in the history
  • Loading branch information
ssbarnea authored Oct 9, 2022
1 parent aa8618e commit 0a9275b
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 56 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
[![](https://img.shields.io/pypi/v/tendo.svg?colorB=green)](https://pypi.python.org/pypi/tendo/)
[![](https://img.shields.io/codecov/c/github/pycontribs/tendo/main.svg)](https://codecov.io/gh/pycontribs/tendo)
[![](https://readthedocs.org/projects/tendo/badge/?version=latest)](http://tendo.readthedocs.io)

# tendo

Tendo is a python module that adds basic functionality that is
not provided by Python. Read the [documentation](https://tendo.readthedocs.org/en/latest/) for more info.

- [transparent Unicode support for text file operations (BOM detection)](https://tendo.readthedocs.org/en/latest/#module-tendo.singleton)
- [console logging coloring](https://tendo.readthedocs.org/en/latest/#module-tendo.colorer)
- enable you to use symlinks under windows
- [python tee implementation](https://tendo.readthedocs.org/en/latest/#module-tendo.colorer) for executing external programs and redirecting their output to both console/file
- [improved execfile](https://tendo.readthedocs.org/en/latest/#module-tendo.execfile2)

## Requirements and compatibility

- python 3.6 or newer
- tox for running tests

## Related projects and packages

- jaraco - http://pypi.python.org/pypi/jaraco.util
- pexpect (maybe)
54 changes: 0 additions & 54 deletions README.rst

This file was deleted.

4 changes: 2 additions & 2 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ author_email = sorin.sbarnea@gmail.com
maintainer = Sorin Sbarnea
maintainer_email = sorin.sbarnea@gmail.com
summary = A Python library that extends some core functionality
long_description = file: README.rst
long_description_content_type = text/x-rst
long_description = file: README.md
long_description_content_type = text/markdown
home_page = https://github.com/pycontribs/tendo
license_files = LICENSE.txt
classifier =
Expand Down

0 comments on commit 0a9275b

Please sign in to comment.