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

DOC: add documentation on app usage to the output README.md #5

Open
khiron opened this issue Jul 23, 2024 · 2 comments
Open

DOC: add documentation on app usage to the output README.md #5

khiron opened this issue Jul 23, 2024 · 2 comments
Assignees

Comments

@khiron
Copy link
Collaborator

khiron commented Jul 23, 2024

Update the cookiecutter output README.md, which is the readme that will appear at the root of the expanded project - as opposed to the readme for the app_template project, which is how to run cookiecutter.

We need to;

  • give some examples for how to call an app
  • whether the dev should make an app composable
  • naming conventions for apps and how to resolve collisions
@GavinHuttley
Copy link
Contributor

I need to expand the description on the codent3.org site and then just link to that in this template.

This is the page that needs to be modified. Will do that first.

@GavinHuttley
Copy link
Contributor

I think just add a link to https://cogent3.org/doc/app/user_function.html in the read me is sufficient.

@GavinHuttley GavinHuttley assigned khiron and unassigned GavinHuttley Jul 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants