Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Readme update #18

Open
LMJ-19 opened this issue Jun 16, 2020 · 1 comment
Open

Readme update #18

LMJ-19 opened this issue Jun 16, 2020 · 1 comment

Comments

@LMJ-19
Copy link

LMJ-19 commented Jun 16, 2020

While creating a beta competition example snippet we (mostly Martijn) noticed some small typo's / things that could be updated in the snippet:

in the readme:

  • So build and see the docs see the [docs README](docs/README.md).: So --> To
  • Copyright 2018 QuTech (TUDelft and TNO): 2018 --> 2020

in the docs/readme:

  • which makes use of the command open. If you're on Linux and open does not work you can add alias open='xdg-open to you rc-file.: missing an ' after 'xdg-open

in requirements.txt:

  • it would be good to add pip>=19.0, since we tested with a VirtualEnv which defaults with pip v9 which does not work with NetSquid

in cookiecutter.json:

  • the default NetSquid requirement is ">=0.8.0,<0.9.0", with the beta release we coud (or should) update this to ">=0.9.0,<1.0.0". In the example snippet I need netsquid>=0.9.1
@LMJ-19
Copy link
Author

LMJ-19 commented Jun 17, 2020

in install.md:

  • There are the general installation instructions for NetSquid snippet packages.: There --> These

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant