From b90f199d6e2fe8e17eeb90c2a8c27f59e7459e6d Mon Sep 17 00:00:00 2001 From: Matt Dodson <47385188+MattDodsonEnglish@users.noreply.github.com> Date: Sun, 28 Jan 2024 21:40:57 -0300 Subject: [PATCH 1/2] Add content to readme --- README.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d7d18eac94..1822852108 100644 --- a/README.md +++ b/README.md @@ -1 +1,34 @@ -# marketcetera +# Marketcetera + +Open-source algorithmic trading platform. +Write trading strategies, define parameters of risk, and administrate distributed trading teams. + +Marketcetera is designed for low-latency, high-volume trading activities across computing clusters. +First released in 2006, Marketcetera has been in continuous use for some of the world's largest trading operations for over 15 years. + +## Get started + +Review the [documentation](``/) for the complete guides. + +To get started: + +1. [Install Marketcetera](``/docs/category/install). You can install with the pre-built binary, the official Docker container, or by building from source. +1. Connect to Market data. The [Marketcetera API](https://repo.marketcetera.org/javadoc/4.0.2/platform/apidocs/) has a functional area to connect to a market data source. +1. Write a [strategy](/docs/category/strategu) that listens to FIX messages and makes orders based on the conditions. +1. Monitor your strategy and refine it. + +## Concepts + +- **Strategies.** Marketcetera can run any strategy that compiles to a Java Archive file. +Thus, Java is an obvious choice of language to write the strategies in, but it is not the only. +You also should be able to use one of the many to-Java transpilers to write strategies in the language of your choice. + +- **Monitoring**. As your strategies run, you can monitor the orders and FIX activity. Marketcetera has a built-in UI, [Photon](``/docs/install/photon), that reports messages and trades. You are also free to extend Marketcetera with the reporting tool of your design. + +- **Architecture**. Marketcetera is designed for low latency trades, and over distributed systems. Most of the directories in this repository correspond to a designated function. To learn more about this, read the [Architecture docs](``/docs/category/architecture). + +## Contributors + +- Colin Duplantis, architect +- [Matt Dodson](https://wellshapedwords.com), technical writing +- [Yesica Torrico](https://www.linkedin.com/in/yesica-t-uxui/), UX/UI design From a9a98e550e4234afbe416427ab03c97cdac286d7 Mon Sep 17 00:00:00 2001 From: Matt Dodson <47385188+MattDodsonEnglish@users.noreply.github.com> Date: Wed, 31 Jan 2024 21:46:08 -0300 Subject: [PATCH 2/2] Update README.md --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1822852108..893bfb17b4 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,13 @@ # Marketcetera -Open-source algorithmic trading platform. -Write trading strategies, define parameters of risk, and administrate distributed trading teams. -Marketcetera is designed for low-latency, high-volume trading activities across computing clusters. +Marketcetera is an open-source algorithmic trading platform. +It is designed to support low-latency, high-volume trading across computing clusters. + + First released in 2006, Marketcetera has been in continuous use for some of the world's largest trading operations for over 15 years. +It has modules to run trading strategies, define parameters of risk, and provision and monitor distributed trading teams. + ## Get started @@ -14,7 +17,7 @@ To get started: 1. [Install Marketcetera](``/docs/category/install). You can install with the pre-built binary, the official Docker container, or by building from source. 1. Connect to Market data. The [Marketcetera API](https://repo.marketcetera.org/javadoc/4.0.2/platform/apidocs/) has a functional area to connect to a market data source. -1. Write a [strategy](/docs/category/strategu) that listens to FIX messages and makes orders based on the conditions. +1. Write a [strategy](/docs/category/strategies) that listens to FIX messages and makes orders based on the conditions. 1. Monitor your strategy and refine it. ## Concepts @@ -25,7 +28,7 @@ You also should be able to use one of the many to-Java transpilers to write stra - **Monitoring**. As your strategies run, you can monitor the orders and FIX activity. Marketcetera has a built-in UI, [Photon](``/docs/install/photon), that reports messages and trades. You are also free to extend Marketcetera with the reporting tool of your design. -- **Architecture**. Marketcetera is designed for low latency trades, and over distributed systems. Most of the directories in this repository correspond to a designated function. To learn more about this, read the [Architecture docs](``/docs/category/architecture). +- **Architecture**. Marketcetera is designed for low-latency trades and distributed systems. Most of the directories in this repository correspond to a designated function. To learn more about this, read the [Architecture docs](``/docs/category/architecture). ## Contributors