Skip to content

Commit 017cce6

Browse files
TanziTanzi
authored andcommitted
add readme file and update the git ignore file
1 parent 3dc6ccc commit 017cce6

File tree

2 files changed

+38
-1
lines changed

2 files changed

+38
-1
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
__pycache__/
1+
__pycache__/
2+
dist/
3+
*.egg-info/

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
2+
<!-- @import "[TOC]" {cmd="toc" depthFrom=1 depthTo=6 orderedList=false} -->
3+
4+
<!-- code_chunk_output -->
5+
6+
- [1. installation](#1-installation)
7+
- [1.1. install with this folder](#11-install-with-this-folder)
8+
- [1.2. Install with wheel file](#12-install-with-wheel-file)
9+
- [1.2.1. build the wheel file](#121-build-the-wheel-file)
10+
- [1.2.2. install the wheel file](#122-install-the-wheel-file)
11+
- [2. Usage](#2-usage)
12+
13+
<!-- /code_chunk_output -->
14+
15+
# 1. installation
16+
## 1.1. install with this folder
17+
Open a command ternimal, and then switch to the project directory(where `setup.py` is). Then use the command below to install
18+
```bash
19+
pip install mypackage
20+
```
21+
## 1.2. Install with wheel file
22+
### 1.2.1. build the wheel file
23+
```bash
24+
py -m build
25+
```
26+
then it will create a folder `dist` and a folder `mypackage.egg-info`
27+
* there are `*.tar.gz` and `*.whl` in the folder `dist`
28+
### 1.2.2. install the wheel file
29+
```bash
30+
pip install wheel_name.whl
31+
```
32+
33+
# 2. Usage
34+
There is a demo:
35+
* `test.py` in this folder

0 commit comments

Comments
 (0)