Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ChungZH/notepanda

📃 A simple cross-platform notepad. Based on Qt and C++.
https://github.com/ChungZH/notepanda

arch cmake cpp cpp11 cross-platform desktop-app editor kde notepad qt qt5 text

Last synced: 10 days ago
JSON representation

📃 A simple cross-platform notepad. Based on Qt and C++.

Host: GitHub
URL: https://github.com/ChungZH/notepanda
Owner: ChungZH
License: mit
Created: 2020-04-26T04:01:54.000Z (over 4 years ago)
Default Branch: dev
Last Pushed: 2024-06-10T00:43:02.000Z (5 months ago)
Last Synced: 2024-10-15T18:22:37.291Z (20 days ago)
Topics: arch, cmake, cpp, cpp11, cross-platform, desktop-app, editor, kde, notepad, qt, qt5, text
Language: C++
Homepage: https://t.me/notepanda
Size: 4.24 MB
Stars: 336
Watchers: 12
Forks: 62
Open Issues: 11
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

awesome-qt - ChungZH/notepanda: 📃 A simple cross-platform notepad. Based on Qt and C++.

README

        ![banner](./images/banner.png)

###### Notepanda's icon is owned by ChungZH, any unanthorized usage will be blamed.

# Notepanda

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/a226323cc991499b9c324238949d3cb5)](https://app.codacy.com/manual/ChungZH/notepanda?utm_source=github.com&utm_medium=referral&utm_content=ChungZH/notepanda&utm_campaign=Badge_Grade_Dashboard)

![C++ & Qt](https://img.shields.io/badge/C%2B%2B%20%26%20Qt-forever-ff69b4?style=flat) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FChungZH%2Fnotepanda.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FChungZH%2Fnotepanda?ref=badge_shield)

![LICENSE](https://img.shields.io/github/license/ChungZH/notepanda)

![Made with love](https://img.shields.io/badge/Made%20with-love-red?style=flat)

![Build CI](https://github.com/ChungZH/notepanda/workflows/Build%20CI/badge.svg)

> **A simple cross-platform notepad. Based on Qt and C++.**

If you want to track the latest news of Notepanda, welcome to our [📰 Telegram channel](https://t.me/notepanda)!

BTW you can read this post in my blog: [Notepanda 开发小结](https://blog.chungzh.cn/articles/notepanda/)

## Why write this text editor?

I recently started getting started with Qt, this is my first Qt project, the first C++ project, and the first project in my life. I hope to develop my skills through this project.

I'm not going to use this as a replacement for my other text editors because it's too simple and I am too poor :)

So enjoy this toy 🍵️

## Screenshots

|                Light                 |                Dark                 |

| :----------------------------------: | :---------------------------------: |

| ![Light](./images/notepanda-sc1.png) | ![Dark](./images/notepanda-sc3.png) |

| ![Light](./images/notepanda-sc2.png) | ![Dark](/images/notepanda-sc4.png)  |

## Feature

- Basic operation

- Line numbers

- Syntax highlight

- Launch from the shell by typing: `notepanda` or `notepanda CMakeLists.txt`

- Preview panel (Support Markdown & HTML)

- Opening files with Drag and Drop.

## Install

If you are Windows / MacOS / Linux user, you can go to [Releases](https://github.com/ChungZH/notepanda/releases) page.

If you are using [Scoop](https://scoop.sh), you can get Notepanda from my sweet scoop bucket [🍑 peach](https://github.com/ChungZH/peach):

```powershell

scoop bucket add peach https://github.com/ChungZH/peach

scoop install notepanda

```

If you are Arch Linux (or Arch-based distros) user, you can get Notepanda from AUR. ![AUR Badge](https://img.shields.io/aur/version/notepanda)

You may use an AUR helper such as `yay` to automatically handle the build process of AUR packages:

```sh

yay -S notepanda

```

The latest version is `v0.1.4` now.

## Build

For more information, go to [How to build - GitHub Wiki](https://github.com/ChungZH/notepanda/wiki/How-to-build---%E5%A6%82%E4%BD%95%E6%9E%84%E5%BB%BA).

### Required Tools

- [CMake](https://cmake.org/) >= 3.1.0

- [Ninja](https://ninja-build.org/)

### Required Dependencies

- [Qt](https://www.qt.io/) >= 5.11 (recommendation 5.14)

- [KSyntaxHighlighting](https://api.kde.org/frameworks/syntax-highlighting/html/index.html)

    - [Extra CMake Modules](https://api.kde.org/ecm/)

## Roadmap

See [Projects](https://github.com/ChungZH/notepanda/projects/).

## Contributions / Bugs

![PRs Welcome](https://img.shields.io/badge/%F0%9F%A4%9DPRs-welcome-blue)

You want to contribute to Notepanda? Awesome! ~~Please read the contribution guidelines for details and useful hints.~~ There is **no rules** now!

If you found a bug or have a feature request, you can report it [GitHub Issue](https://github.com/ChungZH/notepanda/issues).

🙇‍♂️️ Thank you very much!

## Special Thanks

- [Qv2ray](https://github.com/qv2ray/qv2ray)

## Copyright

Copyright (c) ChungZH.

**Libraries that have been used in Notepanda are listed below (Sorted by date added):**

- Please see: [assets/CREDIT.md](assets/CREDIT.md)

## LICENSE

⚖ Released under the [MIT license](/LICENSE.Md).

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FChungZH%2Fnotepanda.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FChungZH%2Fnotepanda?ref=badge_large)

------

🗒️ Notepanda © ChungZH.

> [Blog](https://blog.chungzh.cn/) · [Portfolio](https://chungzh.cn/) · [GitHub](https://github.com/ChungZH)