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

Rename fj-host to fj-app #187

Closed
4 tasks done
hannobraun opened this issue Feb 15, 2022 · 4 comments
Closed
4 tasks done

Rename fj-host to fj-app #187

hannobraun opened this issue Feb 15, 2022 · 4 comments
Labels
type: feature New features and improvements to existing features

Comments

@hannobraun
Copy link
Owner

hannobraun commented Feb 15, 2022

The name fj-host makes sense from the perspective of the plugin system (it's an application that hosts model plugins), but I think it doesn't make a lot of sense from a user's perspective. I think fj-viewer is a better name, as that's what it is: A viewer for Fornjot models.

Here's how I'd like to go about this:

  • Rename the crate.
  • Change nomenclature around the repository; code, README, etc.
  • Leave placeholder crate in fj-host directory. Include a README that points to fj-viewer
  • Add blocked issue to remove fj-host from repository after next release.
@hannobraun hannobraun added the type: feature New features and improvements to existing features label Feb 15, 2022
@hannobraun
Copy link
Owner Author

I found some notes on how this transition should be done. Updated the issue description accordingly.

@hannobraun
Copy link
Owner Author

I think there are good reasons against calling the app fj-viewer, as suggested here:

  • At some point in the future, we might want to have an fj-viewer library, so different viewer applications can be build .
  • We might include editing features in them at a later date.

Both cases would require another rename. Since this is the end-user-visible face of Fornjot, each rename is unfortunate.

Maybe it would be best to just call is fj-app. That name is future-proof and won't conflict with any libraries we might extract later.

@hannobraun hannobraun changed the title Rename fj-host to fj-viewer Rename fj-host to fj-app Mar 16, 2022
@hannobraun
Copy link
Owner Author

I've decided to call it fj-app, as per my previous comment.

@hannobraun
Copy link
Owner Author

This has been completed. #358 has been opened to track the removal of the fj-host placeholder crate. Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: feature New features and improvements to existing features
Projects
None yet
Development

No branches or pull requests

1 participant