Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
srwi authored Jan 30, 2024
1 parent 9bfd2ab commit b057b68
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,15 @@
![Build](https://github.com/srwi/MockSign/actions/workflows/github-actions.yml/badge.svg)
[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/srwi/MockSign/blob/master/LICENSE)

Simulate the look of hand signed and scanned documents. MockSign draws inspiration from
[FalsiSign](https://gitlab.com/edouardklein/falsisign), developed by Edouard Klein.
Simulate the look of hand-signed and scanned documents. MockSign is a simple tool to help you shortcut the tedious process of printing, hand-signing and scanning documents.

![MockSign Screenshot](https://github.com/srwi/FalsiSignPy/assets/17520641/2ec12a25-ec97-4dca-a551-27a4d44c2602)
<p align="center">
<img src='https://github.com/srwi/MockSign/assets/17520641/b787a307-4d77-473a-8d45-c61643dc68c8' width='80%'>
</p>

## Installation

Use [pip](https://pip.pypa.io/en/stable/) to install MockSign with
Use pip to install MockSign with

```bash
pip install git+https://github.com/srwi/MockSign
Expand All @@ -19,10 +20,14 @@ pip install git+https://github.com/srwi/MockSign
## Usage

Before using MockSign, a collection of real signature images is needed. This can be
done by scanning and cropping signatures and saving them into a folder.
achieved by scanning and cropping signatures using an image editing program like [Gimp](https://www.gimp.org/) and saving them into a designated folder.

Afterwards, MockSign can be started with `mocksign`.

## License
<p align="center">
<img src='https://github.com/srwi/FalsiSignPy/assets/17520641/2ec12a25-ec97-4dca-a551-27a4d44c2602' width='80%'>
</p>

MockSign is licensed under the [MIT](https://github.com/srwi/MockSign/blob/master/LICENSE) license.
## License & Attribution

MockSign is licensed under the [MIT](https://github.com/srwi/MockSign/blob/master/LICENSE) license and draws inspiration from [FalsiSign](https://gitlab.com/edouardklein/falsisign) by Edouard Klein.

0 comments on commit b057b68

Please sign in to comment.