Skip to content

Commit 64f4583

Browse files
committed
update README with information about the build
1 parent 56feb53 commit 64f4583

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

+18-3
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,11 @@ The GitHub repository is a mirror of the GitLab repository.
1313
- [PostgreSQL](https://www.postgresql.org/download/)
1414
- [.NET 7.0 SDK](https://dotnet.microsoft.com/en-us/download)
1515

16+
### Download
17+
The latest BenchStore build can be downloaded via [releases](https://github.com/staticafi/BenchStore/releases).
18+
19+
The top level folder contains the `appsettings.json` configuration file.
1620
### Appsettings
17-
After downloading the project files, edit the `appsettings.json` configuration file inside the `BenchStoreMVC` project.
1821
```json
1922
"TableGenerator": {
2023
"PythonPath": null,
@@ -31,7 +34,7 @@ Set `TableGenerator__TableGeneratorPath` to the path of the `table-generator` ex
3134
Set `Storage__ResultStoragePath` to the path where you want the result files to get stored.
3235

3336
### Connection string
34-
To set the connection string for the PostgreSQL database, you can edit the `appsettings.json`'s `ConnectionStrings__BenchStoreContext` inside the `BenchStoreMVC` project.
37+
To set the connection string for the PostgreSQL database, you can edit the `appsettings.json`'s `ConnectionStrings__BenchStoreContext`.
3538
```json
3639
"ConnectionStrings": {
3740
"BenchStoreContext": "Host=; Database=; Username=; Password="
@@ -52,6 +55,18 @@ CUSTOMCONNSTR_BenchStoreContext="Host=<hostname>; Database=<database-name>; User
5255
```
5356

5457
### Quickstart
58+
On Windows, you can execute the `BenchStoreMVC.exe` file.
59+
60+
Alternatively, run:
61+
```bash
62+
dotnet BenchStoreMVC.dll
63+
```
64+
65+
### Development
66+
For a development version of BenchStore, you can download the project files.
67+
68+
The `BenchStoreMVC` project contains the `appsettings.json` file with the needed configuration. Alternatively, you can create your own `appsettings.Development.json` configuration file which is ignored by Git and overwrites the settings from the `appsettings.json` file.
69+
5570
From the root level of the repository run:
5671
```bash
5772
dotnet run --project ./BenchStoreMVC/
@@ -62,7 +77,7 @@ Alternatively, in the `./BenchStoreMVC` directory run:
6277
dotnet run
6378
```
6479

65-
### Development
80+
#### Visual Studio
6681
A development version of BenchStore can be started with [Visual Studio](https://visualstudio.microsoft.com/) on Windows.
6782

6883
The Visual Studio project is started with the `BenchStore.sln` file.

0 commit comments

Comments
 (0)