From e4a8ff9d13b37026d34304ec2d06715b9b05be32 Mon Sep 17 00:00:00 2001 From: rly Date: Tue, 27 Feb 2024 07:54:27 +0000 Subject: [PATCH 1/3] Update installation instructions --- docs/developer_guide.rst | 10 ++++++---- docs/installation.rst | 18 ++++++++++++------ 2 files changed, 18 insertions(+), 10 deletions(-) diff --git a/docs/developer_guide.rst b/docs/developer_guide.rst index 972ccdb5f..1fabc5dd3 100644 --- a/docs/developer_guide.rst +++ b/docs/developer_guide.rst @@ -24,7 +24,6 @@ Start by cloning the repository Install Python Dependencies ^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Install the appropriate Python dependencies for your operating system. **Windows** @@ -51,6 +50,10 @@ Install the appropriate Python dependencies for your operating system. conda env create -f ./environments/environment-Linux.yml + +Activate the Python Environment +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Before starting NWB GUIDE, you'll need to ensure that the Python environment is activated. .. code-block:: bash @@ -58,8 +61,8 @@ Before starting NWB GUIDE, you'll need to ensure that the Python environment is conda activate nwb-guide -Installing JavaScript Dependencies -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Install JavaScript Dependencies +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Next, install all JavaScript dependencies based on the `package-lock.json` file. @@ -78,7 +81,6 @@ You can now run the following command to start the application using Electron. npm start - Repo Structure -------------- 1. **src/renderer/src** - Contains all the source code for the frontend diff --git a/docs/installation.rst b/docs/installation.rst index 147de87ad..a0f9a4a7c 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -5,22 +5,28 @@ Installation Windows ------- -Download and run the `NWB-GUIDE-Setup-vX.Y.Z.exe `_ file and follow all instruction prompts. +Download and run `NWB-GUIDE-x64.exe `_ and follow all instruction prompts. MacOS - Intel ------------- -Download the `NWB-GUIDE-vX.Y.Z.dmg `_ file, which should prompt you to move it into your 'Applications' folder in order to run. +Download `NWB-GUIDE-x64.dmg `_, which should prompt you to move it into your 'Applications' folder in order to run. MacOS - Apple Silicon --------------------- -Download the `NWB-GUIDE-vX.Y.Z-arm64.dmg `_ file, which should prompt you to move it into your 'Applications' folder in order to run. +Download `NWB-GUIDE-arm64.dmg `_, which should prompt you to move it into your 'Applications' folder in order to run. .. 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` instructions. -Ubuntu ------- +Linux +----- + +Please clone the :linux-fix:`linux-fix <>` branch of the NWB GUIDE and follow the :ref:`Developer Installation instructions` after the "Clone the Repo" step. + +.. code-block:: bash + + git clone --branch linux-fix https://github.com/NeurodataWithoutBorders/nwb-guide.git + cd nwb-guide -Please clone the :linux-fix:`linux-fix <>` branch of the NWB GUIDE and follow the :ref:`Developer Installation instructions` on this documentation after the "Clone the Repo" step. From fb6a2f046b7af0fe6e5efca02938a83e4827fcb6 Mon Sep 17 00:00:00 2001 From: rly Date: Tue, 27 Feb 2024 07:58:14 +0000 Subject: [PATCH 2/3] Remove unnecessary .git from clone command --- docs/installation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation.rst b/docs/installation.rst index a0f9a4a7c..5350fa06e 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -27,6 +27,6 @@ Please clone the :linux-fix:`linux-fix <>` branch of the NWB GUIDE and follow th .. code-block:: bash - git clone --branch linux-fix https://github.com/NeurodataWithoutBorders/nwb-guide.git + git clone --branch linux-fix https://github.com/NeurodataWithoutBorders/nwb-guide cd nwb-guide From 4b21336fbdeb410192c542be358ae062430d70bb Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 27 Feb 2024 07:58:38 +0000 Subject: [PATCH 3/3] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/installation.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/installation.rst b/docs/installation.rst index 5350fa06e..563dc9e5f 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -29,4 +29,3 @@ Please clone the :linux-fix:`linux-fix <>` branch of the NWB GUIDE and follow th git clone --branch linux-fix https://github.com/NeurodataWithoutBorders/nwb-guide cd nwb-guide -