Skip to content

Commit e011608

Browse files
committed
Update readme
1 parent 9f18eb6 commit e011608

4 files changed

Lines changed: 17 additions & 7 deletions

File tree

.github/workflows/badge-binary.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Binary Badge
1+
name: Binary
22

33
on:
44
push:

.github/workflows/badge-designer-plugin.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Designer Plugin Badge
1+
name: Designer Plugin
22

33
on:
44
push:

.github/workflows/badge-library.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Library Badge
1+
name: Library
22

33
on:
44
push:

readme.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
11
QHexEdit2
22
=========
3+
4+
[![.github/workflows/badge-library.yml](https://github.com/Simsys/qhexedit2/actions/workflows/badge-library.yml/badge.svg)](https://github.com/Simsys/qhexedit2/actions/workflows/badge-library.yml)
5+
[![.github/workflows/badge-binary.yml](https://github.com/Simsys/qhexedit2/actions/workflows/badge-binary.yml/badge.svg)](https://github.com/Simsys/qhexedit2/actions/workflows/badge-binary.yml)
6+
[![.github/workflows/badge-designer-plugin.yml](https://github.com/Simsys/qhexedit2/actions/workflows/badge-designer-plugin.yml/badge.svg)](https://github.com/Simsys/qhexedit2/actions/workflows/badge-designer-plugin.yml)
7+
8+
39
![Application QHexEdit2 in Action](http://simsys.github.io/qhexedit.png)
410

511

6-
QHexEdit is a hex editor widget written in C++ for the Qt (Qt4, Qt5, Qt6) framework. It is a simple editor for binary data, just like QPlainTextEdit is for text data. There are sip configuration files included, so it is easy to create bindings for PyQt and you can use this widget also in python 2 and 3.
12+
QHexEdit is a hex editor widget written in C++ for the Qt (Qt5, Qt6) framework. It is a simple editor for binary data, just like QPlainTextEdit is for text data. There are sip configuration files included, so it is easy to create bindings for PyQt and you can use this widget also in python.
713

814
QHexEdit takes the data of a QByteArray (setData()) and shows it. You can use the mouse or the keyboard to navigate inside the widget. If you hit the keys (0..9, a..f) you will change the data. Changed data is highlighted and can be accessed via data().
915

@@ -16,17 +22,21 @@ QHexEdit comes with undo/redo functionality. All changes can be undone, by press
1622
QHexEdit is based on QIODevice, that's why QHexEdit can handle big amounts of data. The size of edited data can be more then two gigabytes without any restrictions.
1723

1824
## Using QHexEdit (C++)
19-
You can read the documentation of the project [here](http://simsys.github.io/). You find in the sources a [C++ example](https://github.com/Simsys/qhexedit2/tree/master/example), that shows how tu use the QHexedit widget.
25+
You can read the documentation of the project [here](http://simsys.github.io/). You find in the sources a [C++ example](https://github.com/Simsys/qhexedit2/tree/master/example), that shows how to use the QHexedit widget. The binaries for the example for the Windows platform are stored with the respective [release](https://github.com/Simsys/qhexedit2/releases).
2026

2127
## Using QHexEdit (Python)
2228
To use QHexEdit with Python install it from PyPi:
29+
2330
```
2431
$ # for PyQt5
25-
$ pip install PyQt5-QHexEdit
32+
$ pip install PyQt5 PyQt5-QHexEdit
2633
$
2734
$ # for PyQt6
28-
$ pip install PyQt6-QHexEdit
35+
$ pip install PyQt5 PyQt5-QHexEdit
2936
```
37+
38+
The sources and binaries for Windows 64 bit and Linux 64 bit are stored on PyPi. For all other targets, the widget must be compiled locally. For this, the corresponding Qt version including the developer packages must be installed. It makes sense to compile the C++ project first. If this is possible with qmake, it is also possible to compile the PyQt bindings. This requires [python build](https://pypi.org/project/build/).
39+
3040
There is also a [python example](https://github.com/Simsys/qhexedit2/tree/master/python/example) available.
3141

3242
## Contributing to QHexEdit

0 commit comments

Comments
 (0)