-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e399096
commit 2ff163f
Showing
1 changed file
with
46 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,46 @@ | ||
# protogui | ||
# protogui | ||
|
||
**protogui** is a simple and intuitive graphical interface designed to encode and decode Protobuf messages. This tool makes it easy to work with binary messages in the Protocol Buffers format, offering a practical and efficient way to handle such data. | ||
|
||
## Features | ||
|
||
- **Encode**: Convert structured data into Protobuf binary messages. | ||
- **Decode**: Transform Protobuf binary messages into readable formats. | ||
- User-friendly and easy-to-navigate interface. | ||
|
||
## Requirements | ||
|
||
- [Golang](https://golang.org/) installed on your system (minimum recommended version: 1.18). | ||
- This tool was developed using the Fyne library, please check prerequisites [here](https://docs.fyne.io/started/) | ||
|
||
|
||
## Installation | ||
|
||
To install the tool, follow these steps: | ||
|
||
1. Clone the **protogui** repository: | ||
```bash | ||
git clone https://github.com/lawmatsuyama/protogui.git | ||
``` | ||
2. Navigate to the repository's directory: | ||
```bash | ||
cd protogui | ||
``` | ||
3. Run the `go install` command to install the tool: | ||
```bash | ||
go install | ||
``` | ||
Once installed, the **protogui** executable will be available in your `$GOPATH/bin`. | ||
## Usage | ||
1. Open a terminal prompt. | ||
2. Run the `protogui` command: | ||
```bash | ||
protogui | ||
``` | ||
The graphical interface will launch, allowing you to quickly encode and decode Protobuf messages. | ||