Skip to content

rohankishore/ZenNotes

Repository files navigation

ZenNotes

License Demo Demo

ZenNotes is being ported to macOS by @matthewyang204. Check the repo here

✍️ What is ZenNotes?

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

image

image


📃 Features

  • Edit files (duh)
  • Windows Fluent Design with Mica support
  • Built-in Translation
  • Text to Speech
  • Encrypt and Decrypt
  • Markdown support (Note: BR and HR may require closing tags to work)

👒 Getting Started

Let's get ZenNotes set up on your PC!

Prerequisites

  • Windows 10 x64 or later, a Linux distro running kernel 6.x or later, or macOS 11+
  • Python 3.9 or later
  • Python installation is bootstrapped with pip
  • (Recommended) A fresh venv created with python -m venv venv and activated with venv\Scripts\activate
  • The contents of requirements.txt installed via pip install -r requirements.txt
  • (If building an installer) Inno Setup 6.4.3 or later

Installation

You can download a prebuilt installer from the Releases or build one yourself. If using prebuilt installers, just skip to the use section.

Building the installer

  1. Clone the repo or download a tarball
  2. Install all prerequisites
  3. python build.py to compile the program first
  4. Open up the .iss Inno Setup script and compile it via Ctrl+F9 or Build > Compile - installer can be found in Output folder
Using the installer

Just run the .exe file, duh.

Testing

This is for people who solely just want to run without installation for mostly testing purposes.

We need the prerequisites above. After getting them, you can run the program with pythonw main.py to run it without flooding your terminal with logging, or you can just run with python main.py to troubleshoot errors and debug it.


💖 Credits & Acknowledgements

This project was made possible because of zhiyiYp's PyQt-Fluent-Widgets.

Icon Credit : Fluent Icons


🪪 License

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

About

Windows Notepad Replacement with Translation, TTS, and much more!

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •