Skip to content

Commit

Permalink
Update README and contributing guides
Browse files Browse the repository at this point in the history
  • Loading branch information
NicolasHug committed May 19, 2024
1 parent a998422 commit 8f03012
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 14 deletions.
13 changes: 4 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,19 +25,13 @@ Before submitting a new pull request, please make sure that:
Set up
------

It's highly recommended to use a virtual environment. All the packages needed
for the development of Surprise (sphinx, flake8, etc...) can be installed by
running
Clone the repo then:

pip install -r requirements_dev.txt

Then, you can install your local copy of the repo:

pip install -e .
pip install -e . # the --no-build-isolation flag might help

Any change to the code should now be immediately reflected during execution. If
you're modifying Cython code (`.pyx` files), you'll need to compile the code in
order to see the changes. This can be achieved by running `pip install -e .`
order to see the changes. This can be achieved by running the command above
again.

Running and writing tests
Expand All @@ -60,6 +54,7 @@ Building the docs locally
The docs can be compiled with

cd doc
pip install -r requirements.txt
make html

You can check the results in `doc/build/html`. Please make sure that the docs
Expand Down
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,10 +149,8 @@ example](https://github.com/NicolasHug/Surprise/tree/master/examples/benchmark.p
Installation
------------

With pip (you'll need [numpy](https://www.numpy.org/), and a C compiler. Windows
users might prefer using conda):
With pip (you'll need a C compiler. Windows users might prefer using conda):

$ pip install numpy
$ pip install scikit-surprise

With conda:
Expand All @@ -163,10 +161,9 @@ For the latest version, you can also clone the repo and build the source
(you'll first need [Cython](https://cython.org/) and
[numpy](https://www.numpy.org/)):

$ pip install numpy cython
$ git clone https://github.com/NicolasHug/surprise.git
$ cd surprise
$ python setup.py install
$ pip install .

License and reference
---------------------
Expand Down

0 comments on commit 8f03012

Please sign in to comment.