microsoft / yardl

Tooling for streaming instrument data
https://microsoft.github.io/yardl/
MIT License
29 stars 5 forks source link

environment.yml is overcomplete (and Linux specific) #71

Closed KrisThielemans closed 8 months ago

KrisThielemans commented 9 months ago

On Windows from Powershell.

mamba env create  --file environment.yml

Looking for: ['bash-completion=2.11', 'ccache=4.5.1', 'clang-format=14.0.4', 'cmake=3.21.3', 'fmt=8.1.1', 'gcc_linux-64]

Could not solve for environment specs
Encountered problems while solving:
  - nothing provides requested bash-completion 2.11**
  - nothing provides requested gcc_linux-64 11.2.0**
  - nothing provides requested gdb 11.2**
  - nothing provides requested gxx_linux-64 11.2.0**
  - nothing provides requested valgrind 3.18.1**

The environment can't be solved, aborting the operation

I guess we should remove valgrind and gdb? Even bash_completion and ccache. Maybe even clang-format.

Of course, the justfile is bash/Linux specific as well and I guess Windows support is for later.

PS: Is pinning the compiler version etc best practice? Maybe some of these could be >=?

hansenms commented 9 months ago

This environment file is not meant to work on Windows it is to set up a full development environment (for tool and all tests) in a Linux devcontainer. If you just want to work with this in Windows, follow the quickstart instructions for C++ or Python.

And we do need those tools in the devcontainer to have a fully functional development environment.

If you just want to use the yardl too, grab a release from here: https://github.com/microsoft/yardl/releases/

KrisThielemans commented 9 months ago

aha! Great. My mistake. I was reading https://github.com/microsoft/yardl/tree/v0.3.0#building-the-code-in-this-repo, but didn't read the quickstart. (Usual problem with documentation: people read the wrong bit 😉 ).

Maybe the README.md could say "if you want to use yardl, get the executable from the latest release"?

johnstairs commented 8 months ago

Going to close this. In the README, we have a "getting started" link (appearing before the contributing section)