Skip to content

Commit

Permalink
Prettier readmes (#385)
Browse files Browse the repository at this point in the history
* Update README.md

* Update CONTRIBUTING.md

* added space
  • Loading branch information
mgiulini authored Feb 6, 2024
1 parent ea9d049 commit 14f71e5
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
2 changes: 0 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Developing ARCTIC-3D

This section is still work in progress

## Installation

We use `poetry` to manage the dependencies and the virtual environment, so it makes things easier if you need to install it first; check the [official documentation](https://python-poetry.org/docs/#installation) for more details.
Expand Down
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,15 @@ Check [CONTRIBUTING.md](CONTRIBUTING.md) for more information.

### With `conda`

Clone the repository on your computer and navigate to it

```bash
git clone [email protected]:haddocking/arctic3d.git
cd arctic3d
```

Here you can create the arctic3d environment:

```bash
conda create -n arctic3d python=3.10
conda activate arctic3d
Expand Down Expand Up @@ -59,3 +68,9 @@ sphinx-build -E docs ./arctic3d-docs
```

Then you can open the file `arctic3d-docs/index.html`, which contains all the necessary documentation.

## Citing us

If you used ARCTIC-3D in your work please cite the following publication:

**Marco Giulini, Rodrigo V. Honorato, Jesús L. Rivera, and Alexandre MJJ Bonvin**: "ARCTIC-3D: automatic retrieval and clustering of interfaces in complexes from 3D structural information." Communications Biology 7, no. 1 (2024): 49. (www.nature.com/articles/s42003-023-05718-w)

0 comments on commit 14f71e5

Please sign in to comment.