Skip to content

Commit 289d127

Browse files
committed
Update plain-start readme
1 parent 8cdf43c commit 289d127

File tree

1 file changed

+0
-39
lines changed

1 file changed

+0
-39
lines changed

plain-start/plain/start/README.md

Lines changed: 0 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
**Bootstrap a new Plain project from official starter templates.**
44

5-
## Contents
6-
75
- [Overview](#overview)
86
- [Starter types](#starter-types)
97
- [Options](#options)
@@ -18,8 +16,6 @@ Basic usage:
1816

1917
```bash
2018
uvx plain-start my-project
21-
cd my-project
22-
uv run plain dev
2319
```
2420

2521
This creates a new project called `my-project` using the full app starter template (with ORM, auth, admin, etc.).
@@ -79,38 +75,3 @@ Skip running the `./scripts/install` script after cloning. Useful if you want to
7975
```bash
8076
uvx plain-start my-project --no-install
8177
```
82-
83-
## FAQs
84-
85-
#### What does the install script do?
86-
87-
The `./scripts/install` script sets up your Python environment using `uv`, installs dependencies, and runs initial migrations for the database. You can always run it manually later if you use `--no-install`.
88-
89-
#### Can I use plain-start with a specific version?
90-
91-
Yes, you can specify a version using `uvx`:
92-
93-
```bash
94-
uvx plain-start@0.1.0 my-project
95-
```
96-
97-
#### What gets replaced in the project?
98-
99-
The command updates the `name` field in your `pyproject.toml` to match your project name. All other configuration remains as-is for you to customize.
100-
101-
## Installation
102-
103-
Install and run `plain-start` using `uvx` (recommended):
104-
105-
```bash
106-
uvx plain-start my-project
107-
```
108-
109-
Or install it globally:
110-
111-
```bash
112-
uv tool install plain-start
113-
plain-start my-project
114-
```
115-
116-
The command clones the starter template, configures your project name, initializes a new git repository, and runs the installation script (unless you pass `--no-install`).

0 commit comments

Comments
 (0)