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.

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

Add direct installation links #599

Merged
merged 8 commits into from
Feb 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 15 additions & 9 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,26 @@

Installation
===============

Begin by downloading the latest release from the :releases:`GitHub release page <>`.
============

Windows
----------------------
-------

Download and run the `NWB-GUIDE-Setup-vX.Y.Z.exe <https://github.com/NeurodataWithoutBorders/nwb-guide/releases/latest/download/NWB-GUIDE-Setup-0.0.13.exe>`_ file and follow all instruction prompts.

MacOS - Intel
-------------

Download the `NWB-GUIDE-vX.Y.Z.dmg <https://github.com/NeurodataWithoutBorders/nwb-guide/releases/latest/download/NWB-GUIDE-0.0.13.dmg>`_ file, which should prompt you to move it into your 'Applications' folder in order to run.

Run the `setup.exe` file and follow all instructions.
MacOS - Apple Silicon
---------------------

MacOS
---------------------------
Download the `NWB-GUIDE-vX.Y.Z-arm64.dmg <https://github.com/NeurodataWithoutBorders/nwb-guide/releases/latest/download/NWB-GUIDE-0.0.13-arm64.dmg>`_ file, which should prompt you to move it into your 'Applications' folder in order to run.

Run the `.dmg` file and follow all instructions to move the file into your Applications folder.
.. note::
Some data formats can have issues using this build of the application. If you encounter errors when using a particular interface, try following the advanced :ref:`Developer Installation instructions<developer_installation>` instructions.

Ubuntu
---------------------------
------

Please clone the :linux-fix:`linux-fix <>` branch of the NWB GUIDE and follow the :ref:`Developer Installation instructions<developer_installation>` on this documentation after the "Clone the Repo" step.
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
},
"build": {
"appId": "com.catalystneuro.nwbguide",
"artifactName": "NWB-GUIDE-${arch}.${ext}",
"generateUpdatesFilesForAllChannels": true,
"afterSign": "./notarize.js",
"fileAssociations": [
Expand Down
Loading