villano-lab / nrCascadeSim

calculating the NR spectrum resulting from neutron-capture cascades.
MIT License
0 stars 1 forks source link

WSL installation instructions #79

Closed nuclearGoblin closed 2 years ago

nuclearGoblin commented 2 years ago

Does your pull request resolve or partially resolve an issue? Yes

If Yes, which issue? This resolves #76.

Does your pull request implement code improvements? No - documentation only.

Does your pull request implement any breaking changes? No.

Testing:
This pull request: [ ] Alters the existing CI in some way. [ ] Adds a new step to the CI. [X] Does not introduce any features that the CI could not already test. (sort of) [X] Is not accompanied by necessary CI changes due to some limitation described below. (Please also describe how new features can be manually tested.) I attempted to include a test of the installation, as now instructed in the docs, on WSL. However, the support for Windows in Travis is still in early access, and seemed to be missing features that we use for the other builds - so I was not able to implement it at this time. The instructions can be tested manually by following the installation instructions found in section 1 (Getting Started) of the readthedocs pages.