Skip to content

Commit ebd0129

Browse files
authored
Fix bullet points in components README (#56192)
1 parent fd73ff2 commit ebd0129

File tree

1 file changed

+40
-35
lines changed

1 file changed

+40
-35
lines changed

src/Components/README.md

Lines changed: 40 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -37,49 +37,52 @@ The following contains a description of each sub-directory in the `Components` d
3737

3838
1. Ensure the repository is clean from any asset that could remain from previous version of the repository. This is recommended when switching branches, or after updating the working branch.
3939

40-
```powershell
41-
git clean -xdff
42-
```
40+
```powershell
41+
git clean -xdff
42+
```
4343
44-
You may need to kill some processes holding on files that are being deleted, like closing Visual Studio and other `msbuild` or `dotnet` processes. There may also be lingering headless `chrome` processes, but they are not included in this command. The following command may help you but be aware that this could also stop other important tasks:
44+
You may need to kill some processes holding on files that are being deleted, like closing Visual Studio and other `msbuild` or `dotnet` processes. There may also be lingering headless
45+
`chrome` processes, but they are not included in this command. The following command may help you but be aware that this could also stop other important tasks:
4546
46-
```powershell
47-
Get-Process dotnet, escape-node-job, msbuild, VBCSCompiler, node, vstest.console, Microsoft.CodeAnalysis.LanguageServer -ErrorAction Continue | Stop-Process;
48-
```
47+
```powershell
48+
Get-Process dotnet, escape-node-job, msbuild, VBCSCompiler, node, vstest.console, Microsoft.CodeAnalysis.LanguageServer -ErrorAction Continue | Stop-Process;
49+
```
4950
5051
1. Use NPM to restore the required JavaScript modules. This doesn't require an Internet connection since the sources are read from a sub-module.
5152
52-
```powershell
53-
npm ci --offline
54-
```
53+
```powershell
54+
npm ci --offline
55+
```
5556
5657
1. You'll need to run the `restore` script locally to install the required dotnet dependencies and setup the repo. The `restore` script is located in the root of the repo.
58+
59+
```bash
60+
# Linux or Mac
61+
./restore.sh
62+
```
5763
58-
```bash
59-
./restore.sh
60-
```
61-
62-
```powershell
63-
./restore.cmd
64-
```
64+
```powershell
65+
# Windows
66+
./restore.cmd
67+
```
6568
6669
1. Now you can build all the JavaScript assets required by the repository (including SignalR for instance) by running the following command:
6770
68-
```powershell
69-
npm run build
70-
```
71+
```powershell
72+
npm run build
73+
```
7174
7275
1. Build the Components:
7376
74-
```powershell
75-
./src/Components/build.cmd
76-
```
77+
```powershell
78+
./src/Components/build.cmd
79+
```
7780
7881
2. Optionally, open the Components in Visual Studio:
7982
80-
```powershell
81-
./src/Components/startvs.cmd
82-
```
83+
```powershell
84+
./src/Components/startvs.cmd
85+
```
8386
8487
### Test
8588
@@ -103,19 +106,21 @@ follow the previous build steps and then these commands:
103106
104107
1. Activate the locally installed .NET by running the following command.
105108
106-
```bash
107-
source activate.sh
108-
```
109+
```bash
110+
# Linux or Mac
111+
source activate.sh
112+
```
109113
110-
```powershell
111-
. ./activate.ps1
112-
```
114+
```powershell
115+
# Windows
116+
. ./activate.ps1
117+
```
113118
114119
1. Start the tests.
115120
116-
```powershell
117-
dotnet test ./src/Components/test/E2ETest
118-
```
121+
```powershell
122+
dotnet test ./src/Components/test/E2ETest
123+
```
119124
120125
Note, you may wish to filter tests using the `--filter` command (ie. `dotnet test --filter <TEST_NAME> ./src/Components/test/E2ETest`).
121126

0 commit comments

Comments
 (0)