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

MAJOR CHANGE: Rename "konsole" to something else #74

Closed
bitspittle opened this issue Dec 26, 2021 · 2 comments
Closed

MAJOR CHANGE: Rename "konsole" to something else #74

bitspittle opened this issue Dec 26, 2021 · 2 comments
Assignees
Labels
enhancement New feature / functionality process Backend work that needs to be done, likely not user visible
Milestone

Comments

@bitspittle
Copy link
Contributor

The name Konsole sits too closely to KDE Konsole, which is confusing.

So, this bug is a few parts...

  1. Remove all references of the name "konsole" from class, method, and variable names, e.g. konsoleApp -> session and konsoleVarOf to liveVarOf
    • Once this is done, the code itself will no longer care about large refactorings of name changes in the future.
  2. Come up with a new name for the library. I'm leaning on "Kotter" for "KOTlin TERminal" but I'm open to other ideas
  3. Update the package / artifacts / README / screencasts / this repo name / our Discord channel etc. to match

This is a pretty big change for this library. This may inconvenience users who are using it, so I'll give this bug a day or two just in case anyone wants to respond. But so far, I haven't seen much of an indication that people are actually using it yet, so it seems like a good time to make such a drastic change.

@bitspittle bitspittle added enhancement New feature / functionality process Backend work that needs to be done, likely not user visible labels Dec 26, 2021
@bitspittle bitspittle added this to the MVP milestone Dec 26, 2021
@bitspittle bitspittle self-assigned this Dec 26, 2021
@bitspittle bitspittle pinned this issue Dec 26, 2021
bitspittle added a commit that referenced this issue Dec 26, 2021
@bitspittle
Copy link
Contributor Author

Actually, I'm going to commit to this soon, so I can clear my plate for other work tomorrow.

If this caused anyone confusion or trouble, please let me know in this bug report so I'll know I should have been more careful next time.

bitspittle added a commit to varabyte/media that referenced this issue Dec 26, 2021
bitspittle added a commit that referenced this issue Dec 26, 2021
@bitspittle bitspittle unpinned this issue Dec 26, 2021
@bitspittle
Copy link
Contributor Author

Migration steps after changing your dependencies from com.varabyte.konsole to com.varabyte.kotter

From To
KonsoleApp Session
KonsoleBlock Section
KonsoleAnim Anim
konsoleApp session
konsole section
konsoleVarOf liveVarOf
konsoleListOf liveListOf
konsoleAnimOf animOf

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature / functionality process Backend work that needs to be done, likely not user visible
Projects
None yet
Development

No branches or pull requests

1 participant