From d7ffe8b0cf1acbbd5d02e29d3e0643a9dd86a504 Mon Sep 17 00:00:00 2001 From: geekan Date: Thu, 13 Jul 2023 14:15:55 +0800 Subject: [PATCH] add help doc to README --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index 6d01973ab..d2057a4bb 100644 --- a/README.md +++ b/README.md @@ -113,6 +113,36 @@ ## Tutorial: Initiating a startup After running the script, you can find your new project in the `workspace/` directory. +### Usage + +``` +NAME + startup.py - We are a software startup comprised of AI. By investing in us, you are empowering a future filled with limitless possibilities. + +SYNOPSIS + startup.py IDEA + +DESCRIPTION + We are a software startup comprised of AI. By investing in us, you are empowering a future filled with limitless possibilities. + +POSITIONAL ARGUMENTS + IDEA + Type: str + Your innovative idea, such as "Creating a snake game." + +FLAGS + --investment=INVESTMENT + Type: float + Default: 3.0 + As an investor, you have the opportunity to contribute a certain dollar amount to this AI company. + --n_round=N_ROUND + Type: int + Default: 5 + +NOTES + You can also use flags syntax for POSITIONAL ARGUMENTS +``` + ### Code walkthrough ```python