From fbfcc725ee7da18011584a139c3e5c10a8ee0d9f Mon Sep 17 00:00:00 2001 From: Bart Schilperoort Date: Wed, 12 Apr 2023 16:57:15 +0200 Subject: [PATCH] Change miss hit instructions --- CONTRIBUTING.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f193542d..0ca2d975 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -161,8 +161,11 @@ When you submit a pull request, the code is also [checked](https://github.com/Ec The status of `MISS_HIT` checks is shown below the pull request. The checks should be successful (green) before merging the pull request. MISS_HIT is configured in [`miss_hit.cfg`](./miss_hit.cfg). -For more details see the following instructions: -
Installation instructions +### Installing MISS_HIT +It is best practice to install packages in environments. See the dropdown menu for instructions. +However, you can also continue below to install MISS_HIT without these steps. + +
Python environment / conda instructions You need to have a valid python installation on your system. @@ -188,8 +191,9 @@ conda env create --name misshit conda activate misshit ``` -### **Install miss_hit** -Install miss hit in the (conda or venv) environment with: +
+ +Install miss hit (optionally in the conda or venv environment) with: ```bash pip install miss-hit ``` @@ -200,4 +204,5 @@ To run the style checker or linter, navigate to the STEMMUS_SCOPE repository, an mh_style mh_lint ``` -
+ +For more information on installing and using MISS_HIT, look at [MISS_HIT's readme](https://github.com/florianschanda/miss_hit#installation-via-pip). \ No newline at end of file