Skip to content

Commit

Permalink
Minor fixes (#134)
Browse files Browse the repository at this point in the history
* Update branch references
  • Loading branch information
jerpint authored Oct 10, 2024
1 parent d9ed66b commit af83f07
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down Expand Up @@ -67,4 +67,4 @@ just pushed, i.e., `[email protected]:${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
mv scripts/README.new.md README.md
5 changes: 2 additions & 3 deletions scripts/quick_install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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..."
Expand Down

0 comments on commit af83f07

Please sign in to comment.