From 1328f45f97b6253c8b6eeb1e7d0ff89f02744ace Mon Sep 17 00:00:00 2001
From: Xu Yang <peteryang@vip.qq.com>
Date: Fri, 9 Aug 2024 14:18:57 +0800
Subject: [PATCH] fix: update command line in readme.md (#192)

* update command line

* remove some todo
---
 README.md | 38 ++++++++++++++++++++++++++++----------
 1 file changed, 28 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index f20f0171..3ebd76df 100644
--- a/README.md
+++ b/README.md
@@ -37,10 +37,10 @@ R&D is a very general scenario. The advent of RDAgent can be your
 - ...
 
 You can click the [🎥link](https://rdagent.azurewebsites.net) above to view the demo. More methods and scenarios are being added to the project to empower your R&D processes and boost productivity.
-
+<!-- 
 We have a quick 🎥demo for one use case of RDAgent.
 - TODO: Demo
-
+ -->
 
 # ⚡Quick start
 You can try our demo by running the following command:
@@ -55,8 +55,11 @@ You can try our demo by running the following command:
   conda activate rdagent
   ```
 
+### 🛠️ Install from pip
+  ```sh
+  pip install rdagent
+  ```
 ### 🛠️ Run Make Files
-TODO: `pip install rdagent` in the future.
 
 - **Navigate to the directory containing the MakeFile** and set up the development environment:
   ```sh
@@ -69,25 +72,40 @@ TODO: `pip install rdagent` in the future.
   - The `.env.example` file contains the environment variables required for users using the OpenAI API (Please note that `.env.example` is an example file. `.env` is the one that will be finally used.)
   - please refer to [Configuration](docs/build/html/installation.html#azure-openai) for the detailed explanation of the `.env`
 ### 🚀 Run the Application
-TODO: run the front-page demo.
 
 The [🎥demo](https://rdagent.azurewebsites.net) is implemented by the following commands:
 
-- Run the factor extraction and implementation application based on financial reports:
+- Run the Qlib factor extraction and implementation application based on financial reports:
   ```sh
-  rdagent fin_factor_report
+  rdagent fin_factor_report <Your report folder>
   ```
 
-- Run the self-loop factor extraction and implementation application:
+- Run the Qlib self-loop factor proposal and implementation application:
   ```sh
-  python rdagent/app/qlib_rd_loop/factor.py
+  rdagent fin_factor
   ```
 
-- Run the self-loop model extraction and implementation application:
+- Run the Qlib self-loop model proposal and implementation application:
   ```sh
-  python rdagent/app/qlib_rd_loop/model.py
+  rdagent fin_model
   ```
 
+- Run the model extraction and implementation application:
+  ```sh
+  rdagent general_model <Your paper url>
+  ```
+
+- Run the medical self-loop model proposal and implementation application:
+  ```sh
+  rdagent med_model 
+  ```
+  
+
+### 🚀 Monitor the Application
+You can serve our demo app to monitor the RD loop by running the following command:
+```sh
+TODO: run the front-page demo.
+```
 
 # Scenarios