Skip to content

Commit 3e3acf5

Browse files
Update README.md (#185)
* Update README.md ran into some issues when installing and made updates for clarity * Update lychee command
1 parent 92d9e6e commit 3e3acf5

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -20,33 +20,31 @@ Download and install [git](https://git-scm.com/downloads) if it is not installed
2020
> It often appears to hang because it does not output any status information.
2121
> Usually, the command will eventually return.
2222
23-
1. Clone the documentation repository:
23+
1. Using Windows PowerShell or a Git Bash terminal, clone the documentation repository:
2424
``` console
25-
git clone https://github.com/open-ephys/onix1-bonsai-docs
26-
cd onix1-bonsai-docs
25+
git clone https://github.com/open-ephys/bonsai-onix1-docs
26+
cd bonsai-onix1-docs
2727
```
2828
1. Pull in the latest files from the submodules according to the commit that the submodules point to:
2929
``` console
3030
git submodule update --recursive --init
3131
```
3232
In particular, the source code is available in this repo as a submodule. This will update the source code to the latest commit on main.
33-
1. Configure the docfx version and restore docfx companion tools such as [DocLinkChecker](https://github.com/Ellerbach/docfx-companion-tools/tree/main/src/DocLinkChecker).
34-
``` console
35-
dotnet tool restore --configfile ./.bonsai/NuGet.config
36-
```
37-
1. To make the `docfx` command available after restoring the config file from the previous step, run:
33+
1. Configure the docfx version and restore docfx companion tools such as [DocLinkChecker](https://github.com/Ellerbach/docfx-companion-tools/tree/main/src/DocLinkChecker). You need to be in the same root folder where you cloned the repository for this to work. Run:
3834
``` console
3935
dotnet tool restore
4036
```
37+
to make the `docfx` command available.
38+
4139
If the above command yields the following error:
4240
``` console
4341
It was not possible to find any installed .NET Core SDKs
4442
```
4543
even after installing .NET as described previously in the readme, refer to [this comment](https://github.com/dotnet/core/issues/6095#issuecomment-809006602) for a potential fix. If you follow the instructions described in the comment, make sure you proceed in a terminal or command prompt opened after changing the environment variables.
46-
1. Set up a local Bonsai environment for automatically exporting SVGs, run:
44+
1. Set up a local Bonsai environment for automatically exporting SVGs, run Setup.ps1 in PowerShell (or, if not using PowerShell, run Setup.Cmd):
4745
``` console
4846
./.bonsai/Setup.ps1
49-
```
47+
```
5048
If the above command yields the following error:
5149
``` console
5250
./Setup.ps1 : File C:\Users\User\...\bonsai-onix1-docs\Setup.ps1 cannot be loaded because running scripts is
@@ -66,6 +64,8 @@ To build the docs and serve locally, run in PowerShell:
6664
./build.ps1 --serve
6765
```
6866

67+
If this doesn't run, see comment in section above.
68+
6969
If SVGs are already exported and do not need to be updated, they don't need to be re-exported. In that case, to build the docs and serve locally more quickly, run:
7070

7171
``` console
@@ -96,7 +96,7 @@ The above set of commands can also be run using the `docfx-utils.ps1` Powershell
9696
To run the next command, install [Lychee](https://github.com/lycheeverse/lychee?tab=readme-ov-file) by following [these instructions](https://github.com/lycheeverse/lychee?tab=readme-ov-file#installation). If you are use Windows and download a Lychee executable, amend the below command according to the location and version of your Lychee executable, and run it.
9797

9898
``` console
99-
<lychee/installation/directory>/lychee-v<x.xx.x>-windows-x86_64.exe --verbose --no-progress --base _site --exclude ^https://github\.com.*merge.* --exclude ^https://github\.com.*apiSpec.* '_site/**/*.html'
99+
<lychee/installation/directory>/lychee-v<x.xx.x>-windows-x86_64.exe --no-progress --base _site --exclude ^https://github\.com.*merge.* --exclude ^https://github\.com.*apiSpec.* --exclude ^https://github\.com/open-ephys/onix1-bonsai-docs/blob/.*/#L1 '_site/**/*.html' --max-retries 0 --max-concurrency 32 --cache --max-cache-age 1d
100100
```
101101

102102
If you use a different operating systems and a different methods of installation, the above command might require additional amendments.
@@ -187,4 +187,4 @@ If there are discrepancies between local and remote builds:
187187

188188
## Style Guide
189189

190-
Refer to the [Style Guide](style-guide.md).
190+
Refer to the [Style Guide](style-guide.md).

0 commit comments

Comments
 (0)