Skip to content

Commit 516f6bc

Browse files
Update README.md re branch abandonment
1 parent 3e77328 commit 516f6bc

File tree

1 file changed

+33
-48
lines changed

1 file changed

+33
-48
lines changed

README.md

Lines changed: 33 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,52 @@
11
# CodeSnip Belvedere
22

3-
## What is the `belvedere` branch for?
3+
> **Branch abandoned**
4+
>
5+
> The `belvedere` branch, which never really got off the ground, has been moribund since May 2022 and was officially abandoned on 2022-12-03.
6+
>
7+
> The branch will remain in the repository in case some of its code can be salvaged for later use.
8+
>
9+
> :no_entry: Pull requests for this branch are not being accepted.
410
5-
This is yet another attempt to create CodeSnip v5.
11+
## Rationale behind the `belvedere` branch
612

7-
OK, the previous 2 (or 3?) attempts (`parsnip`/`pagoda` and `pavilion`) failed, but they were building on the existing CodeSnip 4 code base and that proved too difficult. There's a lot of _old_ code in there and it's been getting messy for years.
13+
This was yet another attempt to create CodeSnip v5, rashly announced on new year's day 2022 as a new year's resolution. I really am old enough to know better!
814

9-
What is more the CodeSnip 4 code base is stuck with using Delphi XE to compile it. Attempts to get it to compile with Delphi 11 finally succeeded, but introduced so many bugs it didn't seem worth the trouble.
15+
The previous 2 (or 3?) attempts (`parsnip`/`pagoda` and `pavilion`) had failed. The thought was that they failed because they were building on the existing CodeSnip 4 code base and that had proved too difficult. There's a lot of very old code in CodeSnip 4 and it's been getting messy for years.
1016

11-
So, `belvedere` is planned to be a ground-up rebuild - a fresh start.
17+
What is more, the CodeSnip 4 code base was stuck with using Delphi XE to compile it. Attempts to get it to compile with Delphi 11 finally succeeded, but introduced so many bugs it didn't seem worth the trouble.
1218

13-
Now, the `belvedere` branch contains all the old code - it was branched off CodeSnip 4.19.0's code base (since updated with v4.20.0 changes) - **but** new development will take place in a new folder. Some of the old code may be used where it's suitable: it will be copied into the the new folder structure as required.
19+
So, `belvedere` was planned to be a ground-up rebuild - a fresh start.
1420

15-
And will this attempt succeed where the others have failed? Who knows - I just think that it's got more of a chance than the other attempts! Regardless this is a long term project and CodeSnip 4 will continue to be developed.
21+
While the `belvedere` branch did contain all the old code (it was originally branched off CodeSnip 4.19.0's code base), new development was to take place in a new folder. Some of the old code may have been used where it was suitable, but in principle most of it would be rewritten.
1622

17-
## Plans for CodeSnip 5 Belvedere
23+
It was thought that there may be some code from the earlier `pavilion` or `pagoda` branches that may have been some use, because those branches were heading in the same direction.
1824

19-
Initial thoughts are that CodeSnip 5 will:
25+
### Original plans for CodeSnip 5 Belvedere
26+
27+
Initial thoughts were that CodeSnip 5 would:
2028

2129
* Be designed to be 64 bit from the start.
22-
* ~~Use the FireMonkey framework to maximise the chance that the final program will be cross-platform - possibly Windows and Linux. **But** it will be built as Windows first. It's not planned to port it to mobile, and I don't do Mac, so that would be for someone else.~~ **NOTE:** The plan to use FMX was dumped early on because I wanted to use SynEdit and it's VCL only!
23-
* Have high DPI support built in from the ground up. Not having that support in CodeSnip 4 is getting to be a big problem.
24-
* Support storing snippets in other languages while still providing extra facilities for Pascal code, like test compilation.
25-
* Switch to using SynEdit as the code editor to gain the benefit of syntax highlighted code in various languages.
30+
* Use the FireMonkey framework (though this plan soon changed to retaining the VCL).
31+
* Have high DPI support built in from the ground up.
32+
* Support storing snippets in languages other than Pascal.
33+
* Switch to using SynEdit as the code editor (hence the need to keep the VCL).
2634
* No longer render the main display as HTML (if at all possible).
27-
* Finally get rid of the distinction between user-defined snippets and those downloaded from the DelphiDabbler Code Snippets Database - there will only be one database and all snippets will be editable. I'll try to retain a link back to the source of each snippet so those from the DelphiDabbler database will be remain updatable.
28-
* Have a completely new and extensible database format. Could be custom binary, could be SQLite, could be file based like now. But I want to get away from INI and XML files - too cumbersome and too slow.
29-
* Have greatly improved import / export capability, including the ability to import of the **whole** of someone else's database without the need to export it and then import it. It would be great if imported code could be tracked and updatable just like the plan for snippets from the DelphiDabbler database.
30-
* Use a new JSON based config file format?
31-
* Drop support for older OSs - may be Win10/Win11 only?
35+
* Get rid of the distinction between user-defined snippets and those downloaded from the DelphiDabbler Code Snippets Database.
36+
* Have a completely new and extensible database format.
37+
* Have greatly improved import / export capability.
38+
* Switch to using JSON for config files.
39+
* Drop support for older OSs - may be Win10/Win11 only.
3240
* Drop support for legacy CodeSnip file formats from before CodeSnip 4.
33-
* Bring together the standard and portable versions: no more separately compiled versions. CodeSnip will probably run as a standard Windows application if installed in `%ProgramFiles%` and act as a portable application if it's installed anywhere else.
41+
* Bring together the standard and portable versions in one program.
3442
* Support different themes: e.g. light and dark.
35-
* Be more _testable_.
36-
37-
_This list last updated 2022/05/17_
38-
39-
There may be some code in the `pavilion` or `pagoda` branches that I can use, because they were also going in this direction.
40-
41-
Seems a bit ambitious? Well we'll see how it goes.
42-
43-
## Timetable
44-
45-
Oh no, not getting into promising anything! It all depends on how much time and enthusiasm I have. This is my hobby after all.
46-
47-
## Comments & Suggestions Welcome
48-
49-
I'm more than happy to receive suggestions, comments, ideas etc. and you are welcome to use the [CodeSnip 5 Belvedere](https://github.com/delphidabbler/codesnip/discussions/42) discussion thread to share your thoughts. Please use that thread in preference to the Issues page for anything to do with `belvedere`.
50-
51-
## Contributing
52-
53-
I'm not looking for any contributions to `belvedere` at the moment - it's too early in development to be cleat about what's needed.
54-
55-
But as soon as I make enough progress I'll be more than happy to receive help.
56-
57-
In the meantime any assistance maintaining CodeSnip 4 would be greatly appreciated. See `README.md` on the `develop` branch for details.
58-
59-
## Compiling
43+
* Be more testable.
44+
* Be compiled with Delphi 11.
6045

61-
CodeSnip 5 Belvedere is being developed in Delphi 11 and is being compiled from the IDE.
46+
## Failure of `belvedere`
6247

63-
Binaries are being created in the `belvedere\_build` directory.
48+
It soon became obvious that this plan was far too ambitious and development quickly faltered.
6449

65-
## Blog
50+
Added to that, CodeSnip 4 was still receiving updates and many other projects needed attention, limiting the time available.
6651

67-
I'm planning to do an occasional blog post or two if and when I make progress. Those posts will appear on the existing [CodeSnip Blog](https://codesnip-app.blogspot.com/).
52+
So, reluctantly, after 3 or 4 attempts over _nine years_, the plans for a radically different CodeSnip 5 were finally abandoned.

0 commit comments

Comments
 (0)