Skip to content

Conversation

@jayenashar
Copy link

This pull request updates the project setup instructions in the README.md to clarify the initialization process for new and existing projects.

  • Documentation update:
    • Updated the setup steps to recommend codev init for new projects and added codev adopt for existing projects in the README.md instructions.

Updated instructions for initializing a project.
# 2. Initialize a project
mkdir my-project && cd my-project
codev init
codev init # for new projects
Copy link
Contributor

Choose a reason for hiding this comment

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

We can give clearer instructions here:

codev init <dir_name>

or

cd <dir>
codev adopt

Copy link
Author

Choose a reason for hiding this comment

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

codev init prompts me for the directory to create

if you're willing to change the cli, codev init [dir-name] can work for all use cases:

  • no dir-name specified - prompts user (as now)
  • dir-name specified and does not exist - creates folder (as now)
  • dir-name specified, exists, is empty - sets up folder
  • dir-name specified, exists, is not empty - sets up folder (change from now which refuses. adopt can be an alias for init .)

P.S. imho dir-name should be in square brackets to indicate optionality.

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

Successfully merging this pull request may close these issues.

2 participants