diff --git a/installer/mac/README.md b/installer/mac/README.md index 653aa623..fb8863e1 100644 --- a/installer/mac/README.md +++ b/installer/mac/README.md @@ -25,9 +25,7 @@ The Xcode Command Line Tools package includes utilities for compiling code from - If you get the following error, you can skip this step. `xcode-select: error: command line tools are already installed, use "Software Update" to install updates` -2. Then press `Install` in the pop-up dialog - - +2. Then press `Install` in the pop-up dialog. ## Prerequisite 2: Miniconda (Python 3) @@ -82,11 +80,7 @@ cd hnn 2. The HNN GUI should show up. Make sure that you can run simulations by clicking the 'Run Simulation' button. This will run a simulation with the default configuration. After it completes, graphs should be displayed in the main window. -3. When you run simulations for the first time, the following dialog boxes may pop-up and ask you for permission to allow connections through the firewall. Saying 'Deny' is fine since simulations will just run locally on your Mac. - - - - +3. When you run simulations for the first time, two dialog boxes may pop-up and ask you for permission to allow connections through the firewall. Saying 'Deny' is fine since simulations will just run locally on your Mac. 4. You can now proceed to running the tutorials at [https://hnn.brown.edu/index.php/tutorials/](https://hnn.brown.edu/index.php/tutorials/) . Some things to note: diff --git a/installer/ubuntu/README.md b/installer/ubuntu/README.md index faa83f92..611942c1 100644 --- a/installer/ubuntu/README.md +++ b/installer/ubuntu/README.md @@ -73,4 +73,4 @@ If you run into other issues with the installation, please [open an issue on our Another option for users that are running into problems with the above methods, we provide a VirtualBox VM pre-installed with HNN. -* [Virtualbox install instructions](../virtualbox/README.md) +- [Virtualbox install instructions](../virtualbox/README.md) diff --git a/installer/windows/wsl.md b/installer/windows/wsl.md index 81a598dd..e3b357cf 100644 --- a/installer/windows/wsl.md +++ b/installer/windows/wsl.md @@ -4,7 +4,7 @@ Below is Microsoft's guide for installing WSL. Note that both WSL 1 and WSL 2 will work with, but **WSL1 is recommended** because the DISPLAY variable will need to be adjusted with WSL 2. -https://docs.microsoft.com/en-us/windows/wsl/install-win10 +[https://docs.microsoft.com/en-us/windows/wsl/install-win10](https://docs.microsoft.com/en-us/windows/wsl/install-win10) Some notes: @@ -35,7 +35,7 @@ bash hnn-ubuntu.sh Some notes: * You'll be asked for the password you created in WSL (above) -* While it gets tested frequently as part of our automated builds, please let us know if you run into a failure by creating a GitHub issue](https://github.com/jonescompneurolab/hnn/issues). +* While it gets tested frequently as part of our automated builds, please let us know if you run into a failure by [creating a GitHub issue](https://github.com/jonescompneurolab/hnn/issues). You will need to **restart Ubuntu** after this. Until you do so, simulations will fail to run from HNN. @@ -85,28 +85,4 @@ If you still want to use WSL, you can just remove the hnn source code directory ## Troubleshooting -### VcXsrv - -Make sure VcXsrv has been updated to at least 1.20.60. Earlier versions can cause the errors below: - -`hnn_docker.sh` would fail: - -```bash -Starting VcXsrv... done -Checking for xauth... found -Checking for X11 authentication keys... *failed* -``` - -`hnn_docker.log` contains: - -```bash -Retrieving host xauth keys... - - ** Command: /c/Program Files/VcXsrv/xauth.exe -f /c/Users/user/.Xauthority -ni nlist localhost:0 - ** Stderr: C:\Program Files\VcXsrv\xauth.exe: (argv):1: bad display name "localhost:0" in "nlist" command -*failed* -``` - -### Other - If you run into other issues with the installation, please [open an issue on our GitHub](https://github.com/jonescompneurolab/hnn/issues). Our team monitors these issues and will be able to suggest possible fixes.