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

Add a guide for converting an existing project #1961

Open
rmartin16 opened this issue Aug 14, 2024 · 0 comments
Open

Add a guide for converting an existing project #1961

rmartin16 opened this issue Aug 14, 2024 · 0 comments
Labels
documentation An improvement required in the project's documentation. enhancement New features, or improvements to existing features.

Comments

@rmartin16
Copy link
Member

What is the problem or limitation you are having?

With the introduction of Briefcase's Convert command, it is now even easier to support adding Briefcase to existing projects. However, the conversion process makes assumptions and puts requirements on the state of the project to be converted; so, when errors are encountered during the conversion, it may not be obvious how to handle them.

Especially with support for console apps, it seems reasonable that more devs will approach Briefcase as a post-hoc packaging solution for apps that only run in the console.

Describe the solution you'd like

Add a how-to guide for converting an existing project to Briefcase. While I think the guide should help readers to understand how a Briefcase project is structured, I also think it should be somewhat of a checklist to help make sure the conversion will be optimal.

Describe alternatives you've considered

n/a

Additional context

Related:

@rmartin16 rmartin16 added enhancement New features, or improvements to existing features. documentation An improvement required in the project's documentation. labels Aug 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation An improvement required in the project's documentation. enhancement New features, or improvements to existing features.
Projects
None yet
Development

No branches or pull requests

1 participant