Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/canytr/pen
The pen is mightier than the sword.
https://github.com/canytr/pen
cmake cross-platform gui image-editing painting pen qt screen-capture screenshot
Last synced: about 2 months ago
JSON representation
The pen is mightier than the sword.
- Host: GitHub
- URL: https://github.com/canytr/pen
- Owner: Canytr
- License: mit
- Created: 2023-11-22T07:21:56.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-12T12:23:26.000Z (10 months ago)
- Last Synced: 2024-03-13T09:28:24.415Z (10 months ago)
- Topics: cmake, cross-platform, gui, image-editing, painting, pen, qt, screen-capture, screenshot
- Language: C++
- Homepage:
- Size: 249 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pen
### About The Project
This project is developed using the Qt framework and features a drawing tool designed to be useful during online meetings for code reviews. The tool allows users to make drawings and shapes on the screen, making it easier to highlight changes and discuss code modifications.
# Features
- Drawing Abilities: Users can freely draw on the screen and highlight specific areas of code.
- Shape Creation: Enhance code understanding by adding highlights with basic shapes such as rectangles, circles, and lines.
- Color Options: Personalize your drawings with color options, making specific changes or important points more noticeable.
### Future Work
* Multi-User Support
* Screen Recording and Playback
* Code Tagging and Links
* Add a gallery to preview and experiment on previous images
* Advanced Shape and Color Options
* Drawing History and Undo
### Dependencies
- Qt >= 5.9
+ Development tools
- GCC >= 7.4
- CMake >= 3.13
### Installation
Pen can be installed on Linux, Microsoft Windows, and macOS.
1. Clone the repo
```sh
git clone https://github.com/Canytr/Pen.git
```
### Built With CMake
This project leverages the power of Qt, a comprehensive cross-platform C++ framework, to provide a rich and intuitive user interface for effective code reviews. Additionally, CMake orchestrates the build process, ensuring seamless integration and ease of compilation.
CMake reads the CMakeLists.txt file and creates makefiles from it. This means that after we run CMake, we need to run make to actually build our project. We'll do this from a separate directory so the binaries don't clutter up our source directory.
```shell
mkdir build
cd build
cmake ..
make
```
### Contributing
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
### License
Distributed under the MIT License. See [MIT](LICENSE) for more information.