search

alan-turing-institute / DetectorChecker

Project to develop software to assess developing detector screen damage (Web App based on the original DetectorChecker package)
https://detectorchecker.azurewebsites.net
MIT License
0 stars 1 forks source link

Testing on windows #59

Closed OscartGiles closed 5 years ago

OscartGiles commented 5 years ago

Successfully tested on Windows 🥇

I will update development docs on how to do it

OscartGiles commented 5 years ago

@tomaslaz, @WilfridSKendall, @ejulia17

I have been creating a few markdown documents on how to run tests across different operating systems, how to generate documentation etc.

I'm not entirely sure on the best place for these to live. I think it makes sense not to pollute the package with these, but at the same time, have them somewhere sensible so we can find them again.

Perhaps they could live in the DetectorCheckerWebApp developer docs?

What is everyone's thoughts?

ejulia17 commented 5 years ago

About Windows test: That is amazing. I would have never expected to go through without creasing a dozen issues... I'm very relieved.

About your question regarding markdown docs (in your second message in the Windows issue #52): They are general, not just for Windows users, are they? If they are what I think they are, instructions related to the various tasks related to managing and updating the package, I agree they shouldn't be /in/ the package. However, in close proximity would be ideal. Is there anything wrong with putting them at the same level as the directory containing the package? https://github.com/alan-turing-institute/DetectorChecker A name revealing what they contain would also be good.

WilfridSKendall commented 5 years ago

Delighted too to see that Windows tests pass! Not entirely surprised though: good R coders like OTG and TL would instinctively avoid code that made platform-dependent assumptions.

I agree with JAB that documents about eg testing the package should live close to the package -- though we might also need reference to them in DetectorCheckerWebApp. At some stage, when things go wrong, we'll be wanting to ask someone "Could you run the tests and tell us what they say?".

OscartGiles commented 5 years ago

Great, I think I can just add a folder called development_docs/ or similar. And then when people download the package with install_github("alan-turing-institute/DetectorChecker/") these won't get installed with them (but I will double check this).

OscartGiles commented 5 years ago

Added to development_docs folder