From f1a7e08cf258a0c34a57c7e06ad5221ebb11cb74 Mon Sep 17 00:00:00 2001 From: Santhosh Sundaram Date: Fri, 30 Aug 2024 18:19:03 +0530 Subject: [PATCH 1/3] added doc for setting upstream url --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 499ec28..d176e7e 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,8 @@ pybamm-cookie Copier will prompt you with various configurations and you may choose the ones that suit your use case. Additionally you can perform `pybamm-cookie -h` to know the list of actions you can perform with the CLI. -**Note**: A `git` repository is automatically initialised when a project is created within a directory. +> [!NOTE] +> A `git` repository is automatically initialised when a project is created within a directory, to push the contents to upstream GitHub repository, follow these steps in the [GitHub documentation](https://docs.github.com/en/get-started/getting-started-with-git/managing-remote-repositories#adding-a-remote-repository). After generation, you can navigate to the generated project and run `nox -s generated-project-tests` to ensure if the project units are working as intended. From fe925c371f41e4f6bc6283e0d75c80fcf52ba4e7 Mon Sep 17 00:00:00 2001 From: Santhosh <52504160+santacodes@users.noreply.github.com> Date: Sat, 31 Aug 2024 11:40:04 +0530 Subject: [PATCH 2/3] Update README.md Co-authored-by: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d176e7e..1736467 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,7 @@ Copier will prompt you with various configurations and you may choose the ones t Additionally you can perform `pybamm-cookie -h` to know the list of actions you can perform with the CLI. > [!NOTE] -> A `git` repository is automatically initialised when a project is created within a directory, to push the contents to upstream GitHub repository, follow these steps in the [GitHub documentation](https://docs.github.com/en/get-started/getting-started-with-git/managing-remote-repositories#adding-a-remote-repository). +> A `git` repository is automatically initialised when a project is created within a directory. To push the contents to the upstream GitHub repository, follow these steps as listed in the [GitHub documentation](https://docs.github.com/en/get-started/getting-started-with-git/managing-remote-repositories#adding-a-remote-repository). After generation, you can navigate to the generated project and run `nox -s generated-project-tests` to ensure if the project units are working as intended. From 248dcdba5b2a2d155193972b77cdac19c98541d4 Mon Sep 17 00:00:00 2001 From: Santhosh Sundaram Date: Sat, 31 Aug 2024 19:19:23 +0530 Subject: [PATCH 3/3] updated note with better instructions --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1736467..e20b700 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,7 @@ Copier will prompt you with various configurations and you may choose the ones t Additionally you can perform `pybamm-cookie -h` to know the list of actions you can perform with the CLI. > [!NOTE] -> A `git` repository is automatically initialised when a project is created within a directory. To push the contents to the upstream GitHub repository, follow these steps as listed in the [GitHub documentation](https://docs.github.com/en/get-started/getting-started-with-git/managing-remote-repositories#adding-a-remote-repository). +> A `git` repository is automatically initialised when a project is created within a directory. To push the contents to the upstream GitHub repository, create a GitHub repository with the same name as your local repository and do not initialise your GitHub repository with any files such as licenses or README which might conflict with the local repository, follow these steps as listed in the [GitHub documentation](https://docs.github.com/en/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github#adding-a-local-repository-to-github-using-git). After generation, you can navigate to the generated project and run `nox -s generated-project-tests` to ensure if the project units are working as intended.