As the codebase is not frequently updated - the Readme should be updated

[Motti-Shneor]

Hi.
I am using this codebase for years. Here and there I find issues and problems, and I see that although the last official release is v0.3.2 - there have been several other branches, and lots of fixes afterwards.

It is now quite hard to decide which branch or commit to use. I know my own app's OS requirements - but I do not know what is the recommended BSManagedDocument for me.

Can you please spare a few minutes to summarize the status of the code-base?

I also have some fixes - following your recommendations, that never went into the code - Should I create pull-requests? Is this code-base still maintained ?

Thank you.

[evanmiller]

Here's what I have been able to glean:

Official karelia project (Abandoned?)

karelia/v0.3.x is designed for ARC + non-ARC. Supports: 10.6 and later. Last commit: May 15, 2015. Status: Stable.

karelia/v0.4.x is designed for ARC only. Supports: 10.7 and later. Last commit: June 1, 2015. Status: Less stable?

Note: karelia/v0.4.x is pure code cleanup. There are no new features or bug fixes compared to karelia/v0.3.x. In fact, it is a few commits behind karelia/v0.3.x.

Prominent forks (Active)

jerrykrinock/v0.3.x is a fork of karelia/v0.3.x. It continues to support non-ARC and 10.6 and fixes several bugs, I believe including #43 #46 #49. Last commit: May 16, 2019. Status: Stable.

theMikeSwan/v0.5.x is a fork of karelia/v0.4.x. It requires ARC and 10.7 or later. It merges in most of jerrykrinock's fixes, as well as fixes from iml-it, sanderberents, and aufflick. Last commit: October 15, 2018. Status: ??

I have been in communication with jerrykrinock, since he has fixed some fairly deep bugs and I need the non-ARC support for my projects. I plan to make contributions to his fork, though I will be watching theMikeSwan fork closely for bug fixes.

I'll mention @karelia, @jerrykrinock, and @theMikeSwan in case they want to weigh in.

[theMikeSwan]

The primary goal of the fork I made is to combine all the effort that others have put forth in various locations into one place. I do plan to continue pulling in changes from other places as I find them and have time.

It has been a little while since I touched that particular project but last I remember everything works but the undo manager creation was a terrible hack. I feel like there was another issue that I saw one time and so was never able to pin down specifics but I'm pretty sure it was related to either duplicating documents or reverting them. (If anyone takes my fork out for a spin and sees this or any other issues please let me know).

I'm going to hope against hope again this year that the What's New in Core Data session has a new document class that uses Core Data and is the same on both macOS and iOS, but I don't expect it to really happen…

[jerrykrinock]

@theMikeSwan, do let us know, after you have digested whatever bombshells drop today, if you still want to become the main fork. I have some more cleanup to the undo manager area which I'm finishing up.