Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Caio-Coldebella authored and Caio Ruiz Coldebella committed May 4, 2024
1 parent b90c443 commit 637d284
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,18 @@ The software was developed and tested in Ubuntu 22.04, and tested on Windows. Th
## Installation
It is suggested to create a Python environment with Conda:

conda create -n micview python=3.8
conda activate micview
$ conda create -n micview python=3.8
$ conda activate micview

To download the package, do:

git clone https://github.com/MICLab-Unicamp/micview
cd micview
pip install .
$ pip install MICView

Or fork this GitHub Repository:

$ git clone https://github.com/MICLab-Unicamp/micview
$ cd micview
$ pip install .

## Using
You can use the API calling inside a terminal, and calling functions of micview inside your Python code, to call micview inside a terminal do:
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: Linux",
"Operating System :: OS Independent",
],
python_requires='>=3.8',
install_requires=['setuptools', 'numpy>=1.22', 'pillow>=9.0.0',
Expand Down

0 comments on commit 637d284

Please sign in to comment.