-
Notifications
You must be signed in to change notification settings - Fork 396
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Better and friendly read me (#12945)
- reorganize readme for better flow, read better This project has potential but has a meh read me so i decided to make it easy to understand cozy.
- Loading branch information
1 parent
0374d9f
commit 0e56746
Showing
1 changed file
with
52 additions
and
27 deletions.
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,41 +1,66 @@ | ||
| ## [Download TripleA](http://triplea-game.org/download/) | ||
| # TripleA: Open Source Strategy Game Engine | ||
|
|
||
| TripleA (2002) is a fan created open source strategy and board game engine where you can play Axis and | ||
| Allies style rules on community created maps.TripleA has a well-developed AI and an active lobby for live | ||
| multiplayer games. | ||
|  | ||
|
|
||
| In TripleA, players can recreate World War 2 with the Axis pushing through to Moscow and the Allies | ||
| desperately fighting back, Napoleon's march across Europe, Rome defeating the Carthaginian Empire, | ||
| or even Sauron conquering Middle Earth! | ||
| ## About TripleA | ||
|
|
||
| TripleA is a fan-created, open-source strategy and board game engine that brings Axis and Allies-style gameplay to life. Launched in 2002, TripleA offers: | ||
|
|
||
| - ***[Forums: Discussion, Questions & Help](https://forums.triplea-game.org/category/10/help-questions)*** | ||
| - ***[How to Contribute to TripleA](/docs/contribute.md)*** | ||
| - ***[Bug Tracker](https://github.com/triplea-game/triplea/issues/new)*** | ||
| - ***[Developer Setup Guide](/docs/development/README.md)*** | ||
| - ***[](https://github.com/triplea-game/triplea/blob/master/LICENSE)*** | ||
| - Community-created maps | ||
| - Well-developed AI for single-player experiences | ||
| - Active lobby for live multiplayer games | ||
| - Diverse scenarios ranging from World War II to fantasy realms | ||
|
|
||
|  | ||
| ## Key Features | ||
|
|
||
| - **Historical Scenarios**: Recreate pivotal moments in history, such as: | ||
| - The Axis push towards Moscow in WWII | ||
| - Napoleon's march across Europe | ||
| - Rome's conquest of the Carthaginian Empire | ||
| - **Fantasy Realms**: Dive into imaginary worlds, like Sauron's conquest of Middle Earth | ||
| - **Customizable Gameplay**: Enjoy a wide variety of community-created maps and scenarios | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
| ## Getting Started | ||
|
|
||
| ### Download | ||
| Get the latest version of TripleA from our official website: | ||
| [Download TripleA](http://triplea-game.org/download/) | ||
|
|
||
| ### Community and Support | ||
| - [Forums: Discussion, Questions & Help](https://forums.triplea-game.org/category/10/help-questions) | ||
| - [Bug Tracker](https://github.com/triplea-game/triplea/issues/new) | ||
|
|
||
| ## Contributing | ||
|
|
||
| We welcome contributions from the community! Whether you're a developer, designer, or enthusiast, there are many ways to help improve TripleA: | ||
|
|
||
| - [How to Contribute to TripleA](/docs/contribute.md) | ||
| - [Developer Setup Guide](/docs/development/README.md) | ||
|
|
||
| ## License | ||
|
|
||
| TripleA is open-source software licensed under the GNU General Public License v3.0. | ||
|
|
||
|  | ||
| [](https://github.com/triplea-game/triplea/blob/master/LICENSE) | ||
|
|
||
|  | ||
| ### Additional Permissions | ||
|
|
||
| Under GNU GPL version 3 section 7, we grant additional permission to convey the resulting work when combining or linking the Program with the following libraries (or modified versions of these libraries): | ||
|
|
||
| #### Additional permission under GNU GPL version 3 section 7 | ||
| | Library | Group ID | Artifact ID | SPDX License ID | | ||
| |:--------|:---------|:------------|:----------------| | ||
| | Jakarta Mail | com.sun.mail | jakarta.mail | GPL-2.0-only | | ||
|
|
||
| If you modify this Program, or any covered work, by linking or combining it with any | ||
| of the following libraries (or a modified version of those libraries), containing | ||
| parts covered by the terms of the library's associated license, the licensors of | ||
| this Program grant you additional permission to convey the resulting work. | ||
| ## Acknowledgments | ||
|
|
||
| Library | Group ID | Artifact ID | SPDX License ID | ||
| :-- | :-- | :-- | :-- | ||
| Jakarta Mail | com.sun.mail | jakarta.mail | GPL-2.0-only | ||
| ### YourKit Profiler | ||
|
|
||
| ## Open Source Developer License for YourKit Profiler [] | ||
| [](https://www.yourkit.com) | ||
|
|
||
| YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET applications. | ||
| YourKit is the creator of <a href="https://www.yourkit.com/java/profiler/">YourKit Java Profiler</a>, <a href="https://www.yourkit.com/.net/profiler/">YourKit .NET Profiler</a>, and <a href="https://www.yourkit.com/youmonitor/">YourKit YouMonitor</a>. | ||
| YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET applications. YourKit is the creator of [YourKit Java Profiler](https://www.yourkit.com/java/profiler/), [YourKit .NET Profiler](https://www.yourkit.com/.net/profiler/), and [YourKit YouMonitor](https://www.yourkit.com/youmonitor/). | ||
|
|
||
| YourKit grants the TripleA development project an open source license for YourKit Java Profiler. | ||
| We're grateful to YourKit for granting the TripleA development project an open source license for YourKit Java Profiler. |