From 2fc81f24fe7d89bd70952535bbbe0e1da15352e2 Mon Sep 17 00:00:00 2001 From: condaatje Date: Thu, 21 Sep 2023 10:06:48 -0400 Subject: [PATCH 1/3] add workaround for microsoft ssh clone requirements --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index c8d2367..77890f7 100644 --- a/README.md +++ b/README.md @@ -36,12 +36,37 @@ This code depends on the shared memory data headers in the simapi [repo](https:/ git submodule sync --recursive git submodule update --init --recursive ``` + Then to compile simply: ``` mkdir build; cd build cmake .. make ``` + +### A note about GitHub's ssh cloning policy + +if you do not have an ssh key set up in you environment that is registered to a GitHub account, Microsoft will decline the clone request and you'll see a permission error like this: + +``` +git@github.com: Permission denied (publickey). +fatal: Could not read from remote repository. + +Please make sure you have the correct access rights +and the repository exists. +``` + +to get around this, first clone the repository over https, then modify the `.gitmodules` file locally such that ssh urls are replaced with https urls. +You can then continue on to sync and update submodules. + +``` +git clone https://github.com/Spacefreak18/monocoque +cd monocoque +# vim .gitmodules +git submodule sync --recursive +git submodule update --init --recursive +``` + ## Testing ### Setting up Your Arduino Device From fe22aef0c356ad85e9e6487030b2b50c47d1ff60 Mon Sep 17 00:00:00 2001 From: condaatje Date: Fri, 29 Sep 2023 12:12:47 -0400 Subject: [PATCH 2/3] Update .gitmodules ssh -> https gitmodule --- .gitmodules | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitmodules b/.gitmodules index 20e9c5e..ec8f1b9 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,4 @@ [submodule "src/monocoque/simulatorapi/simapi"] path = src/monocoque/simulatorapi/simapi - url = git@github.com:spacefreak18/simapi + url = https://github.com/spacefreak18/simapi + # url = git@github.com:spacefreak18/simapi # ssh is better but Microsoft requires an account From 98601391589f9720f6988bbb7d9c31df69293151 Mon Sep 17 00:00:00 2001 From: condaatje Date: Fri, 29 Sep 2023 12:14:08 -0400 Subject: [PATCH 3/3] Update README.md remove workaround in favour of default success --- README.md | 23 ----------------------- 1 file changed, 23 deletions(-) diff --git a/README.md b/README.md index 77890f7..b571f36 100644 --- a/README.md +++ b/README.md @@ -44,29 +44,6 @@ cmake .. make ``` -### A note about GitHub's ssh cloning policy - -if you do not have an ssh key set up in you environment that is registered to a GitHub account, Microsoft will decline the clone request and you'll see a permission error like this: - -``` -git@github.com: Permission denied (publickey). -fatal: Could not read from remote repository. - -Please make sure you have the correct access rights -and the repository exists. -``` - -to get around this, first clone the repository over https, then modify the `.gitmodules` file locally such that ssh urls are replaced with https urls. -You can then continue on to sync and update submodules. - -``` -git clone https://github.com/Spacefreak18/monocoque -cd monocoque -# vim .gitmodules -git submodule sync --recursive -git submodule update --init --recursive -``` - ## Testing ### Setting up Your Arduino Device