TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project.
TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
- Installation process
- Software dependencies
- Latest releases
- API references
TODO: Describe and show how to build your code and run the tests.
TODO: Explain how other users and developers can contribute to make your code better.
If you want to learn more about creating good readme files then refer the following guidelines. You can also seek inspiration from the below readme files:
UI-->Server:Bad Order Server-->UI:Order error
UI->Server:Market Order Server->UI: Server->TradingAcc:Validation, fild acc TradingAcc->Server:Fills/Part fills TradingAcc->MatchingEngine:Acc cheks balance and risks MatchingEngine->TradingAcc:Fills/Part fills, update position MatchingEngine->Stock:fill order, gemetate primts Stock->MatchingEngine:Get OrderBook for a symbol, snapshot