add help doc to README

This commit is contained in:
geekan 2023-07-13 14:15:55 +08:00
parent fdd68a6caa
commit d7ffe8b0cf

View file

@ -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 <flags>
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