Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add instructions to download from GitHub and how to make a contribution #720

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add instructions to download from GitHub and how to make a contribution #720

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
12f040e
Add instructions to download from GitHub and how to make a contribution
riccardoleone1991 Jun 16, 2022
25dd735
fix hyperlink
jdkent Jun 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/dev_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,18 @@ and then use ``fit`` or ``transform`` methods to apply the algorithm to data (ge
Installation for Development
----------------------------

First, you need to clone the NiMARE repository on github.

.. code-block:: bash

git clone https://github.com/neurostuff/NiMARE.git
Comment on lines +26 to +30
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think creating a fork and cloning that is a necessary step for folks who want to install NiMARE for development.



.. note::

Replace all instances of `/path/to/` with the appropriate path on your
filesystem

Installation with Conda
```````````````````````

Expand Down Expand Up @@ -71,6 +83,12 @@ Once inside the container, you can install NiMARE:
Maintaining NiMARE
------------------

Making Changes
``````````````

Please follow the instructions specified in
`Contributing.md <https://github.com/neurostuff/NiMARE/blob/main/CONTRIBUTING.md/>`_

Labeling PRs
````````````

Expand Down