search

pyOpenSci / cookiecutter-pyopensci

SOON TO BE DEPRECATED! Cookiecutter template for a pyOpenSci Python package.
https://cookiecutter-pyopensci.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
14 stars 7 forks source link

refactoring some instructions #8

Closed choldgraf closed 5 years ago

choldgraf commented 5 years ago

A PR to keep track of things that I run into as I go through the intro tutorial.

I also tried adding the README.rst into the index instead of having it as a separate page, LMK what folks think about that!

choldgraf commented 5 years ago

ok I took a pass through the instructions and I think in general they look good, nice work @kysolvik! If you're fine w/ it, we can merge these changes (if you're happy w/ them) and keep track of to-do items in the issues.

kysolvik commented 5 years ago

this looks really great! Thanks @choldgraf, especially for the added language in the tutorial. Makes it much more clear what the different commands are doing

Do you have a suggestion for a sentence to cover the windows subsystem for linux? I've never used it. We could link to Microsoft's documentation, unless you have other ideas: https://docs.microsoft.com/en-us/windows/wsl/about

choldgraf commented 5 years ago

That's probably what I'd do - just something like:

If you're on Windows 10, you may also want to try `Windows Subsystem for Linux <https://docs.microsoft.com/en-us/windows/wsl/about>`_, which allows you to run a linux command line from within Windows. It is still somewhat experimental, but is useful for developing and testing code written in linux.
kysolvik commented 5 years ago

Great thanks! Merged your changes and I'll add the windows subsystem text