Skip to content

Commit

Permalink
Porytiles 1.x README update
Browse files Browse the repository at this point in the history
  • Loading branch information
grunt-lucas committed Oct 16, 2024
1 parent 6a6f3c9 commit d8f9cca
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion Porytiles-1.x/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Porytiles 1.x

## What Is Porytiles 1.x?
This folder is the home of legacy Porytiles 1.x. Currently, the [Porytiles Releases Tab](https://github.com/grunt-lucas/porytiles/releases) contains builds from the code here in the Porytiles 1.x folder. This will be the supported version of Porytiles for the forseeable future. However, most new features (and some bugs too) will not be fixed in this version. Rather, they will be fixed in an upcoming Porytiles 2.x redux. More on that below.
This folder is the home of legacy Porytiles 1.x. Currently, the [Porytiles Releases Tab](https://github.com/grunt-lucas/porytiles/releases) contains builds from the code here in the Porytiles 1.x folder. This will be the supported version of Porytiles for the forseeable future. It's very usable in its current state, and there is significant documentation [over at the wiki](https://github.com/grunt-lucas/porytiles/wiki) to get you started. There will be occasional tweaks and bugfixes, which should show up in the [Porytiles Releases Tab](https://github.com/grunt-lucas/porytiles/releases) as nightlies. Check back occasionally and always download the latest version. However, most large new features (and some bugs too) will not be fixed in this version. Rather, they will be fixed in an upcoming Porytiles 2.x redux. More on that below.

## Why?
Instead of releasing a 1.0.0 Porytiles, I have instead decided to start working on a from-the-ground-up refactor of Porytiles, which will be known as Porytiles 2.x until it officially releases. The reason for this: the process of rapid iterative development on Porytiles 1.x has accrued significant technical debt. At the moment, the Porytiles 1.x code is so messy that I am having trouble adding features or fixing bugs without introducing further issues and gotchas. Additionally, since starting Porytiles in 2023 as a C++ exploratory project, I have learned much about C++ best practices as well as open source app development. As such, building Porytiles 2.x "from scratch" will give it the best foundation for a bright future.
Expand Down

0 comments on commit d8f9cca

Please sign in to comment.