Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Phoenix rebranding #136

Merged
merged 22 commits into from
Aug 18, 2022
Merged

Phoenix rebranding #136

merged 22 commits into from
Aug 18, 2022

Conversation

RhoSigma-QB64
Copy link
Member

Note: This pull request draws the PR #129 by GeorgeMcGinn obsolete, as it practically overrides his changes, that PR should be closed first.


The changes in this PR will rebrand QB64 to reflect we are developing the Phoenix Edition, a new fork of the software raised from the ashes of its predecessor. This new branding shall visibly distinguish us from other forks of this software out there.

To reach this goal, many of the occurrences of the term QB64 are now called QB64-PE or fully written QB64 Phoenix Edition where applicable. Further file and folder names containing the term qb64 are now renamed into qb64pe.

However, not everything was blindly renamed. Don't forget QB64 is for itself also the name of the programming language, so I closely watched where the term is used in the context of the language and where it is used to denote our software product. I.e. only where the product is denoted, the term was renamed.

Also I've left untouched any internal uses of the QB64 or qb64 terms, which mainly means all kind of variable and constant names used in the software, such as C/C++ precompiler defines, make variables, and BASIC variables.


To make reviewing the changes somewhat easier, I've splitted the whole process into several smaller (overseeable) steps. Matt, please take extra attention to the build script changes. Although I'm pretty sure I've caught everything important.

These two are not referenced/used anywhere in the source and/or make files. However, they are embedded in libqb.cpp, which comes later.
Replaced and renamed icon file and moved it into the regular source folder, adjusted references in setup_lnx.sh
Replaced and renamed icon files, adjusted references in the test.bas files.
- int/src/icon.ico (replaced image but same name, dynamically created from given $EXEICON)
- int/src/icon.rc (updated but same name, dynamically created from given $VERSIONINFO)
- int/src/qb64.ico and src/icon.rc removed (not used anymore since dynamic creation was implemented)
- src/qb64.bas updated (rename comes in a later step)
- src/qb64.ico replaced and renamed
- replaced default icon image data, which is used, if _ICON is used w/o parameter, but no $EXEICON is specified either (see also Step 1)
- this step completes icon related changes
Mentions in the help (*.txt) files are excluded.
- Includes related LNX/OSX files
- Excludes mentions in the help (*.txt) files
- qb64*.bat, .sh, .command, .desktop, .sym to qb64pe*.* respectively
- Excludes mentions in the help (*.txt) files
- rename build artifact names and distribution archive names
- this step completes file name related changes (based on extension, more may come based on "qb64" string)
- checks all remaining occurrences of the term 'qb64', some remain untouched, some are renamed according to context
- also added new logo for README.md
- this step does finalize the 'Phoenix Edition' re-branding
- changes to update code (ignore static _GL pages as mentioned at Discord https://discord.com/channels/975381912350752819/975389657212805160/1007683254792507412 )
- dist script changes
- update internal/help to contain static _GL pages only
@RhoSigma-QB64 RhoSigma-QB64 self-assigned this Aug 12, 2022
@RhoSigma-QB64 RhoSigma-QB64 added this to In progress in Backlog/In Progress via automation Aug 12, 2022
- also switched curl to silent mode to shorten build logs
@GeorgeMcGinn
Copy link
Contributor

GeorgeMcGinn commented Aug 13, 2022

Actually, my changes in PR #129 isn’t in this pull request. My changes were two fold: 1) replace the icon for the desktop, and 2) Change the setup_lnx.sh so it does not overlay QB64 v2.0.2 or other versions people have on their Linux machines. The install replaces the .desktop file, replacing the program assigned to the QB64 icon to the PE edition. PE should be adding their own desktop file and corresponding icons.

EDIT: I also need to add a question about what happens to Windows users. Since I don’t have Windows, I have no idea if this issue with Linux also exists there. As for MACs, you have to manually create your desktop icon, but you will need to create a separate folder to install PE next to QB64. I do that manually on the MAC.

- the pure fact we're running the qb64pe executable causes creation of file tempfoldersearch.bin on LNX/OSX only, which must be deleted after run (this caused LNX/OSX checks to fail)
- Wiki parser: added $ to the list of critical file name chars (LNX/OSX doesn't like those)
@RhoSigma-QB64
Copy link
Member Author

RhoSigma-QB64 commented Aug 13, 2022

@GeorgeMcGinn this PR does replace #129.

  • See commit labeled "Step 2" and compare it to your changes. The only difference is that I've also moved the icon image file from internal/source to ./source (internal/source is more or less a temporary snapshot of the last build) and changed that location in setup_lnx.sh accordingly.
  • The requirements for windows are met in "Step 1, 3 & 4", the icons here come either from $EXEICON, which is then deployed through a dynamically created resource file, or they come from the embedded images in libqb.cpp if no $EXEICON is used.

@RhoSigma-QB64
Copy link
Member Author

RhoSigma-QB64 commented Aug 13, 2022

@GeorgeMcGinn all checks on this PR have passed. If you wish, check out the LNX development build (Artifact) from here https://github.com/QB64-Phoenix-Edition/QB64pe/actions/runs/2856415539

.ci/make-dist.sh Outdated
# 1. update internal/help from Wiki
# 2. cleanup internal/temp from qb64pe run
./qb64pe -u
rm -f ./internal/temp/tempfoldersearch.bin
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think if you put this step before the clean step above then ./internal/temp should get cleaned up automatically.

CHANGELOG.md Outdated
@@ -1,4 +1,4 @@
# QB64 development build - Changelog
# QB64 Phoenix Edition - Changelog
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I created #138 to determine what to do with this file 🤷 It probably shouldn't be left in this state for the next release.

@@ -12,14 +12,14 @@ BEGIN
BEGIN
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file could actually just be tossed, I apparently didn't remove it when I changed QB64-PE to use $EXEICON and $VERSIONINFO to simplify the build process.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ignore me, this is the internal/source folder not the source folder 🤦 Sorry about that.

Backlog/In Progress automation moved this from In progress to Review in progress Aug 18, 2022
- update make_dist.sh to download files from Phoenix homepage and moved befor clean as suggested.
- get rid of internal/help
- reset .gitignore to disallow any internal\help uploads again (folder is created during build now)
- get rid of old changelog (changes can better be summarized at release pages)
- added a change by @dkearns from the old QB64Team repository (comment highlighting after `REM`)
- also removed changelog.md from make_dist.sh
- make `curl` really quiet with >NUL, --silent does suppress the progress display only
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
3 participants