Skip to content

Commit dd9fed8

Browse files
authored
Update README.md (#14)
1 parent 05fc1d7 commit dd9fed8

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
![CPA Logo](cpa.png)
44

5-
`cpa` is a cli tool for ultra fast setup of new Python & Rust projects. It automates the creation of config files for style & lint checks, gitignore, a basic Dockerfile and Poetry for dependency management. An opinionated set of pre-commit hooks are included for enforcing best practices and reducing dev time.
5+
`cpa` is a cli tool for ultra fast setup of new Python & Rust projects. It automates the creation of config files like style & lint checks, gitignore, Dockerfile, dependency mangement, etc. An opinionated set of pre-commit hooks are included for enforcing best practices & reducing dev time.
66

7-
An example output is provided in [./example](https://github.com/ysawa0/create-python-app/tree/main/example)
7+
Example outputs are provided in [./example](https://github.com/ysawa0/create-python-app/tree/main/example)
88

99
# Installation
1010

11-
### MacOS, Linux
11+
#### MacOS, Linux
1212

13-
Install via script below or get it from [Releases](https://github.com/ysawa0/create-python-app/releases)
13+
Install via script below or get from [Releases](https://github.com/ysawa0/create-python-app/releases)
1414

1515
```bash
1616
curl -sSL https://raw.githubusercontent.com/ysawa0/create-python-app/main/install.sh | bash
@@ -21,14 +21,13 @@ curl -sSL https://raw.githubusercontent.com/ysawa0/create-python-app/main/instal
2121
# The installer will add ~/bin to your PATH
2222
```
2323

24-
### Windows
24+
#### Windows
2525

26-
Download latest binary from [Releases](https://github.com/ysawa0/create-python-app/releases) page
26+
Download latest binary from [Releases](https://github.com/ysawa0/create-python-app/releases)
2727

28-
### Building from source
28+
#### Building from source
2929

3030
```bash
31-
# cd to project
3231
cargo install --path .
3332
```
3433

@@ -55,14 +54,15 @@ Update current working directory with CPA preset.
5554

5655
```bash
5756
cpa update --name myproject --preset python3.10
58-
cpa create --name myproject --preset rust
57+
cpa update --name myproject --preset rust
5958
```
6059

6160
# Goals
6261

6362
- **Speed up Project Creation**: Reduce the time spent on repetitive setup tasks
6463
- **Best Practices**: Encourage best practices for code quality, formatting, and style by including configs for tools like `black`, `isort`, and `flake8`.
65-
- **Automation**: Automate tasks such as generating `.gitignore` files, setting up pre-commit hooks, and configuring code linters and formatters.
64+
- **Automation**: Automate tasks such as generating `.gitignore` files, setting up pre-commit hooks, Github Action CI, configuring linters & formatters.
65+
- Supports Rust and Python.
6666
- Golang support planned
6767

6868
# Contributions and Feedback

0 commit comments

Comments
 (0)