Skip to content

Commit

Permalink
Improve README.md Organization and Visual Appeal (#2011)
Browse files Browse the repository at this point in the history
* Improve README.md Organization and Visual Appeal

Enhanced the structure and visual appeal of the README.md file. Added a table of contents for easier navigation, centered the main title and image for visual appeal, and organized the sections in a more structured way.
  • Loading branch information
Miisan-png authored Jan 10, 2024
1 parent f6112a6 commit f862fdc
Showing 1 changed file with 23 additions and 15 deletions.
38 changes: 23 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,44 @@
<img width="1280" alt="cover" src="https://user-images.githubusercontent.com/2206700/189457799-6327bab0-b085-4421-8640-6a18e395d17d.png">
<p align="center">
<img width="1280" alt="cover" src="https://user-images.githubusercontent.com/2206700/189457799-6327bab0-b085-4421-8640-6a18e395d17d.png">
</p>

# Dialogic
<h1 align="center">Dialogic</h1>

Create dialogs, characters and scenes to display conversations in your Godot games.
<p align="center">
Create dialogs, characters and scenes to display conversations in your Godot games.
</p>

## Table of Contents
- [Version](#version)
- [Installation](#installation)
- [Documentation](#documentation)
- [Testing](#testing)
- [Credits](#credits)
- [License](#license)

## Version (Currently in Alpha)

## Version 2.0 - Alpha ![Godot v4.0](https://img.shields.io/badge/Godot-v4.1-%23478cbf)
Dialogic 2.0 is a major rewrite of the plugin including many compatibility-breaking changes. It is currently developed exclusively for Godot 4 and requires at least Godot 4.1.

[If you are looking for the Godot 3.5 version you can find it here.](https://github.com/dialogic-godot/dialogic/tree/dialogic-1)
![Godot v4.0](https://img.shields.io/badge/Godot-v4.1-%23478cbf)

[If you are looking for the Godot 3.5 version you can find it here.](https://github.com/dialogic-godot/dialogic/tree/dialogic-1)

## Installation
Follow the installation instructions on our [Getting Started](https://dialogic-docs.coppolaemilio.com/getting-started.html#1-installation--activation) documentation.

Dialogic comes with an auto-updater so you can install future versions right from within the plugin.


## Documentation
As the plugin is still in alpha state, only limited documentation is available. However you can read all the existing documentation here:
[Dialogic Documentation](https://dialogic-docs.coppolaemilio.com/)


## Testing

Dialogic uses [Unit Tests](https://en.wikipedia.org/wiki/Unit_testing) to ensure specific parts function as expected. These tests run on every git push and pull request.\
The framework to do these tests is called [gdUnit4](https://github.com/MikeSchulze/gdUnit4) and our tests reside in the [addons/dialogic/Tests/Unit](https://github.com/dialogic-godot/dialogic/tree/main/addons/dialogic/Tests/Unit) path.\
We recommend installing the `gdUnit4` add-on from the `AssetLib`, with this add-on, you can run tests locally.
Dialogic uses [Unit Tests](https://en.wikipedia.org/wiki/Unit_testing) to ensure specific parts function as expected. These tests run on every git push and pull request. The framework to do these tests is called [gdUnit4](https://github.com/MikeSchulze/gdUnit4) and our tests reside in the [addons/dialogic/Tests/Unit](https://github.com/dialogic-godot/dialogic/tree/main/addons/dialogic/Tests/Unit) path. We recommend installing the `gdUnit4` add-on from the `AssetLib`, with this add-on, you can run tests locally.

To get started, take a look at the existing files in the path and read the documentation to [create your first test](https://mikeschulze.github.io/gdUnit4/first_steps/firstTest/).

---

## 📃 Credits
## Credits
Made by [Emilio Coppola](https://github.com/coppolaemilio) and [Jowan-Spooner](https://github.com/Jowan-Spooner).

Contributors: [zaknafean](https://github.com/zaknafean), [thebardsrc](https://github.com/thebardsrc), [and more!](https://github.com/dialogic-godot/dialogic/graphs/contributors).
Expand All @@ -40,4 +47,5 @@ Special thanks: [Arnaud](https://github.com/arnaudvergnet), [AnidemDex](https://

### Thank you to all my [Patreons](https://www.patreon.com/coppolaemilio) and Github sponsors for making this possible!

[MIT License](https://github.com/dialogic-godot/dialogic/blob/main/LICENSE)
## License
This project is licensed under the terms of the [MIT license](https://github.com/dialogic-godot/dialogic/blob/main/LICENSE).

0 comments on commit f862fdc

Please sign in to comment.