diff --git a/README.md b/README.md index 3a5fa05..4a0b853 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ For convenience, you can run: - bash <(curl -s https://raw.githubusercontent.com/mila-iqia/cookiecutter-pyml/main/scripts/quick_install.sh) --project-name my_new_project + bash <(curl -s https://raw.githubusercontent.com/mila-iqia/cookiecutter-pyml/master/scripts/quick_install.sh) --project-name my_new_project replace `my_new_project` with the name of your project (the default value is `amlrt_project`). This will clone and setup the cookiecutter for you in the newly created folder `my_new_project`. @@ -67,4 +67,4 @@ just pushed, i.e., `git@github.com:${GITHUB_USERNAME}/${PROJECT_NAME}.git`). Once you have successfully completed these steps, you can remove this README.md and update it with the template README provided. Adapt it to your needs: - mv scripts/README.new.md README.md \ No newline at end of file + mv scripts/README.new.md README.md diff --git a/scripts/quick_install.sh b/scripts/quick_install.sh index f40416b..8b54e94 100644 --- a/scripts/quick_install.sh +++ b/scripts/quick_install.sh @@ -45,10 +45,9 @@ done # Use the project_name variable echo "Cloning cookie-cutter to: $project_name..." -# TODO: Before merging, revert back to installing from main branch +# TODO: Once this has been properly merged to master, update ref to point to master # git clone https://github.com/mila-iqia/cookiecutter-pyml.git $project_name -# git clone --branch development https://github.com/mila-iqia/cookiecutter-pyml.git $project_name -git clone --branch change-project-name https://github.com/mila-iqia/cookiecutter-pyml.git $project_name +git clone --branch development https://github.com/mila-iqia/cookiecutter-pyml.git $project_name # Remove the .git folder and reinitialize it echo "Initializing the git repository..."