Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
rohankishore authored Oct 13, 2023
1 parent eeaad5e commit 0d4a128
Showing 1 changed file with 50 additions and 1 deletion.
51 changes: 50 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,50 @@
# ZenNotes
<h1 align="center" >ZenNotes</h1>


<div align="center">

<a href="https://opensource.org/licenses/MIT">![License](https://img.shields.io/badge/License-MIT-yellow)</a>
<a href="https://opensource.org/">![Language](https://img.shields.io/badge/Open-Source-blue)</a>
<a href="https://github.com/rohankishore/ZenNotes/releases">![Demo](https://img.shields.io/badge/Download-Now-indigo)</a>
<a href="https://www.fiverr.com/rohancodespy/">![Demo](https://img.shields.io/badge/Fiverr-Hire-green)</a>
</div>

## ✍️ What is ZenNotes?
ZenNotes is a minimalistic Notepad app with a sleek design inspired by the Fluent Design. It offers the familiar look of the Windows Notepad while having much more powerful features like Translate, TTS, etc.

![image](https://github.com/rohankishore/ZenNotes/assets/109947257/53ffc260-051a-4690-bf23-10572d95ec2c)

https://github.com/rohankishore/ZenNotes/assets/109947257/e8a7d44d-6a83-4c38-a4c3-e270d590f891


<br>

## 👒 Getting Started

##### You can either Download Notes(1) by going to the [Releases](https://github.com/rohankishore/ZenNotes/releases) page or build it yourself by following the steps below.

- Clone the repo / Download it
- ```bash
pip install -r requirements.txt
```

- ```bash
python -m main.py
```


<br>

## 💖 Credits & Acknowledgements

This project was made possible because of [zhiyiYp](https://github.com/zhiyiYp)'s [PyQt-Fluent-Widgets](https://github.com/zhiyiYo/PyQt-Fluent-Widgets).

Icon Credit : [Fluent Icons](https://fluenticons.co/)

<br>


## 🪪 License

This project is licensed under the MIT License. See LICENSE.md for more info.

0 comments on commit 0d4a128

Please sign in to comment.