Skip to content

Commit b9bda92

Browse files
committed
doc: update README
1 parent 3c92fa3 commit b9bda92

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,28 @@
11
# python
22

3+
| | |
4+
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5+
| **License** | ![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg?style=flat) |
6+
| **Environment** | ![Ubuntu](https://img.shields.io/badge/-Ubuntu_22.04_LTS-fad9c1.svg?logo=ubuntu&style=flat) <br> ![Docker](https://img.shields.io/badge/-Docker_v26.0.2-0055a4.svg?logo=docker&style=flat) ![Docker Compose](https://img.shields.io/badge/-Docker_Compose_v2.22.0-0055a4.svg?logo=docker&style=flat) <br> ![Python](https://img.shields.io/badge/-Python_3.10-F9DC3E.svg?logo=python&style=flat) ![Poetry](https://img.shields.io/badge/-Poetry-2c2d72.svg?logo=python&style=flat) |
7+
| **Technology** | |
8+
| |
9+
10+
## Requirements
11+
12+
- Docker and docker-compose are required. The versions are as follows.
13+
- Docker: v26.0.2
14+
- Docker Compose: v2.22.0
15+
316
## Getting Started
417

5-
### 1. Clone & Prepare .env
18+
### 1. Clone Repository
619

720
```sh
821
$ git clone [email protected]:nglcobdai/python-template.git
922
$ cd python-template
1023
```
1124

12-
### 2. Create .env
25+
### 2. Create .env file
1326

1427
- copy .env.example to .env
1528

@@ -23,3 +36,9 @@ $ cp .env{.example,}
2336
$ docker-compose build --no-cache
2437
$ docker-compose run --rm project
2538
```
39+
40+
### 4. Run Python Script
41+
42+
```sh
43+
$ python app/main.py
44+
```

0 commit comments

Comments
 (0)