https://github.com/simplyyan/grafyk
create simple graphics with go easily, quickly and lightly.
https://github.com/simplyyan/grafyk
go golang graph graphics ui
Last synced: 10 months ago
JSON representation
create simple graphics with go easily, quickly and lightly.
- Host: GitHub
- URL: https://github.com/simplyyan/grafyk
- Owner: simplyYan
- License: bsd-3-clause
- Created: 2024-02-01T11:02:38.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-01T11:22:33.000Z (almost 2 years ago)
- Last Synced: 2025-02-07T06:22:36.106Z (11 months ago)
- Topics: go, golang, graph, graphics, ui
- Language: Go
- Homepage: https://github.com/simplyYan/grafyk/wiki/Docs
- Size: 15.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# grafyk
Grafyk is a lightweight Go library for creating ASCII art graphs, designed to be easy, fast, lightweight, and straightforward. It supports two types of graphs: progress bars and charts. The graphs are rendered in ASCII format, providing a simple way to visualize information.
## Key Features
- Easy to Use: The library has an intuitive interface, allowing easy creation and manipulation of graphs.
- Fast and Lightweight: Grafyk is designed to be efficient and lightweight, without unnecessary overhead.
- Straightforward: It offers specific functionalities for creating ASCII art progress bars and charts, maintaining a clear scope.
## How to Install
You can install Grafyk using the `go get` command:
```bash
go get github.com/simplyYan/grafyk
```
Make sure to import the library in your Go code after installation:
```go
import "github.com/simplyYan/grafyk"
```
Now you're ready to start using Grafyk in your projects!
Remember to check the documentation and code examples for more details on using the library's features.
## Documentation
Access the documentation on the [Wiki](https://github.com/simplyYan/grafyk/wiki/Docs) of this repository. It is comprehensive and easy to understand.
```bash
https://github.com/simplyYan/grafyk/wiki/Docs
```
## License
Grafyk is distributed under the BSD-3-Clause License. Feel free to use, modify, and distribute it according to the terms of this license.
## How to Contribute
If you want to contribute to Grafyk, we'd be happy to receive your contributions. Here are some ways to contribute:
- Open Issues: Report issues, suggest new features, or improvements by opening issues. This helps maintain a clear record of discussions and needed enhancements.
- Pull Requests: Feel free to open pull requests to fix bugs, add new features, or improve documentation. Be sure to follow the contribution guidelines.
### How to Open a Pull Request
1. Fork the repository.
2. Clone the fork to your local machine: git clone https://github.com/your-username/grafyk.git
3. Create a branch for your changes: git checkout -b my-feature
4. Make your changes and add, modify, or fix features.
5. Commit your changes: git commit -m "Adding new functionality"
6. Push to your fork: git push origin my-feature
7. Open a Pull Request on the project page.