From d4e5828091163201e0b04377558104cf2afd2e03 Mon Sep 17 00:00:00 2001
From: Alex Feyerke <espy@users.noreply.github.com>
Date: Wed, 26 Jun 2024 10:18:25 +0200
Subject: [PATCH] docs: suggested changes from review notes

Co-authored-by: jaimergp <jaimergp@users.noreply.github.com>
---
 README.md | 24 ++++++++----------------
 1 file changed, 8 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index bf5c1bc29..73497478e 100644
--- a/README.md
+++ b/README.md
@@ -110,12 +110,12 @@ When everything is configured you can trigger a build with a push to the feedsto
 Developing `conda-smithy`
 -----------------------
 
-If you don’t already have a conda-based environment manager, install one. For example [Miniconda]((https://docs.anaconda.com/free/miniconda/miniconda-install/)).
+If you don’t already have a conda-based environment manager, install one. For example [Miniconda](https://docs.anaconda.com/free/miniconda/miniconda-install/).
 
-To develop `conda-smithy`, use said environment manager and create an environment based on the `environment.yml`.
+To develop `conda-smithy`, use said environment manager and create an environment based on the included `environment.yml` file.
 
 ```sh
-$ conda env create
+$ conda env create -f environment.yml
 ```
 
 Then activate the environment, check that it works and install the dependencies:
@@ -124,14 +124,14 @@ Then activate the environment, check that it works and install the dependencies:
 $ conda activate conda-smithy
 $ which python
 # ☝️ should now point to an environment-specific python
-$ python -m pip install .
+$ python -m pip install -e . --no-deps
 ```
 
 You might want to switch Python versions, for example if you wish to exactly replicate a CI issue locally. To do that:
 
-- Change the Python version in the `environment.yml`
-- Deactivate and delete old environment, if you have it: `conda deactivate && conda env delete -n conda-smithy`
-- (re-)run `conda env create` and activate the new environment with `conda activate conda-smithy`
+```sh
+conda install -n conda-smithy python=x.y
+```
 
 ### Testing
 
@@ -144,7 +144,7 @@ pytest tests/test_configure_feedstock.py
 
 Run specific test within a file:
 ```sh
-pytest tests/test_configure_feedstock.py -k test_cuda_enabled_render
+pytest tests/test_configure_feedstock.py::test_cuda_enabled_render
 ```
 
 Run with coverage (this is how the tests are run in CI):
@@ -161,12 +161,6 @@ If test coverage is reported as 0%, your `pytest` and `pytest-cov` plugin might
 python -m pytest tests --cov conda_smithy --cov-report lcov --cov-report term-missing
 ```
 
-You may find that your latest changes aren’t reflected in a test run, in such cases, you can try rebuilding the project:
-
-```sh
-python -m pip install -v --no-build-isolation -e . && pytest tests
-```
-
 ### Linting and Formatting
 
 This repo currently uses `flake8` for linting (but doesn’t enforce it) and `black` for auto-formatting. `black` is already configured in the pre-commit hook, but you can run it manually whenever you like with:
@@ -177,8 +171,6 @@ pre-commit run --all-files
 
 To run flake, just type `flake8`. Note that `black` doesn’t auto-fix all errors found by `flake8`.
 
-**Note:** There is [an ongoing effort](https://github.com/conda-forge/conda-smithy/pull/1919) to replace `flake8` with `ruff`, which will then also be able to format away many of the issues it finds.
-
 Releasing conda-smithy
 ----------------------