dstl / Stone-Soup

A software project to provide the target tracking community with a framework for the development and testing of tracking algorithms.
https://stonesoup.rtfd.io
MIT License
400 stars 131 forks source link

Update install instructions to make compatible with zsh #697

Closed DomonkosCs closed 2 years ago

DomonkosCs commented 2 years ago

I've recently tried to install StoneSoup using the provided python -m pip install -e .[dev] command, and it didn't work. I've found out, that when using zsh, the location and the extra have to be enclosed by quotation marks. For the sake of other zsh users, I think a quick instruction could be given in the docs.

codecov[bot] commented 2 years ago

Codecov Report

Merging #697 (542e718) into main (24fd8de) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #697   +/-   ##
=======================================
  Coverage   94.59%   94.59%           
=======================================
  Files         171      171           
  Lines        8619     8619           
  Branches     1666     1666           
=======================================
  Hits         8153     8153           
  Misses        341      341           
  Partials      125      125           
Flag Coverage Δ
integration 69.26% <ø> (+0.02%) :arrow_up:
unittests 92.13% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

sdhiscocks commented 2 years ago

Thanks @DomonkosCs. I think to keep things simple, we could just have the quotations marks adding to the original command, as that'll then make that one command compatible with all.

DomonkosCs commented 2 years ago

Ok, good idea!