add workaround for microsoft ssh clone requirements
This commit is contained in:
parent
f4f0410686
commit
2fc81f24fe
25
README.md
25
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 sync --recursive
|
||||||
git submodule update --init --recursive
|
git submodule update --init --recursive
|
||||||
```
|
```
|
||||||
|
|
||||||
Then to compile simply:
|
Then to compile simply:
|
||||||
```
|
```
|
||||||
mkdir build; cd build
|
mkdir build; cd build
|
||||||
cmake ..
|
cmake ..
|
||||||
make
|
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
|
## Testing
|
||||||
|
|
||||||
### Setting up Your Arduino Device
|
### Setting up Your Arduino Device
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue