Skip to content

Commit c9c8f26

Browse files
committed
Added active badge
1 parent b4a26af commit c9c8f26

File tree

2 files changed

+38
-16
lines changed

2 files changed

+38
-16
lines changed

README.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Working build! Requires local tick data. Evaluate locally with `dotnet test` - 4
88

99
I'm developing a high-performance C# backtesting engine designed to analyze financial data and evaluate multiple trading strategies at scale.
1010

11-
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=mccaffers_backtesting-engine&metric=alert_status)](https://sonarcloud.io/summary/overall?id=mccaffers_backtesting-engine) [![Build](https://github.com/mccaffers/backtesting-engine/actions/workflows/build.yml/badge.svg)](https://github.com/mccaffers/backtesting-engine/actions/workflows/build.yml) [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=mccaffers_backtesting-engine&metric=bugs)](https://sonarcloud.io/summary/new_code?id=mccaffers_backtesting-engine) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=mccaffers_backtesting-engine&metric=coverage)](https://sonarcloud.io/summary/new_code?id=mccaffers_backtesting-engine)
11+
![alt](images/development_active.svg) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=mccaffers_backtesting-engine&metric=alert_status)](https://sonarcloud.io/summary/overall?id=mccaffers_backtesting-engine) [![Build](https://github.com/mccaffers/backtesting-engine/actions/workflows/build.yml/badge.svg)](https://github.com/mccaffers/backtesting-engine/actions/workflows/build.yml) [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=mccaffers_backtesting-engine&metric=bugs)](https://sonarcloud.io/summary/new_code?id=mccaffers_backtesting-engine) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=mccaffers_backtesting-engine&metric=coverage)](https://sonarcloud.io/summary/new_code?id=mccaffers_backtesting-engine)
1212

1313

1414
I'm extracting results and creating various graphs for trend analyses using SciPy for calculations and Plotly for visualization.
@@ -17,33 +17,34 @@ I'm extracting results and creating various graphs for trend analyses using SciP
1717

1818
*Read more results on https://mccaffers.com/randomly_trading/*
1919

20-
### Features
20+
## Features
2121

22-
* Multiple symbol ingest with time synchronisation
23-
* xUnit testing
24-
* Trade Environment
22+
- [x] Multiple symbol ingest with time synchronisation
23+
- [x] 50 xUnit testing across Trade Management, Ingest, Reporting & Utilities
24+
- [x] Trade Environment
2525
* Trade Excution
2626
* Equity Monitoring
27-
* Reporting (ElasticSearch)
27+
- [x] Reporting (ElasticSearch)
2828

29-
### Getting Started
29+
## Getting Started
3030

31-
#### Testing
32-
`dotnet test`
31+
To begin with, ensure you can run the application with `dotnet test`
32+
33+
**Local Terminal**
3334

34-
#### Local Terminal
3535
sh ./scripts/backtesting/run.sh
3636

37-
#### Local Web & Terminal
37+
**Local Web & Terminal** (requires canvasjs.min.js)
38+
3839
sh ./scripts/backtesting/web.sh
3940

40-
### Dependencies
41+
## Dependencies
4142

4243
* dotnet v8
43-
* Charting & Web use, need to accept dotnet's certificates `dotnet dev-certs https --trust`
4444
* ElasticSearch for reporting
4545
* CanvasJS used for charting
4646
* JS libaries `canvasjs.min.js` to be placed within ./src/ui/src/libs/ folder
47+
* Charting & Web use, need to accept dotnet's certificates `dotnet dev-certs https --trust`
4748
* Some financial tick data in CSV format, in the /src/tickdata folder (example provided)
4849

4950
```bash
@@ -52,12 +53,13 @@ sh ./scripts/backtesting/web.sh
5253
2018-01-01T01:00:00.594+00:00,1.35104,1.35065,1.5,0.75
5354
```
5455

55-
### Debugging
56+
## Debugging
57+
5658
If you have changed target frameworks, make sure to update the program path in .vscode `launch.json`
5759

58-
### Random Trading Strategy
60+
## Random Trading Strategy
5961
accountEquity=0
6062
maximumDrawndownPercentage=0
6163

62-
### License
64+
## License
6365
[MIT](https://choosealicense.com/licenses/mit/)

images/development_active.svg

Lines changed: 20 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)