Skip to content

Commit 0f05ebd

Browse files
committed
Update README.md for release
1 parent 6b551e8 commit 0f05ebd

File tree

1 file changed

+29
-15
lines changed

1 file changed

+29
-15
lines changed

README.md

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,50 @@
1-
# EVE tools for trading
1+
# EVE Tools for trading
22

33
> A collection of trading tools that are helpful for EVE game plays.
44
55
_Author: Hanbo Guo_
66

7-
_EVE character name: Hanbie Serine_
7+
_EVE character: Hanbie Serine_
88

99
_Contact: hbopublic@163.com_
1010

1111

12+
## What is EVE Tools
13+
14+
EVE Tools is a Python package that simplifies EVE ESI. The goal is to write easier and faster Python scripts that analyze EVE data for ISK making.
15+
1216
## Installations
1317

14-
#### 0. Have a working Python environment.
15-
#### 1. Download everything to local.
16-
#### 2. Run the `requirements.txt` file with pip install.
18+
### 0. Have a working Python environment.
19+
### 1. Install using PyPI
20+
```sh
21+
pip3 install eve_tools
22+
```
23+
-----
24+
or
25+
### 1. Install manually
26+
27+
#### 1.1 Download everything under this repo
28+
29+
#### 1.2 Run `requirements.txt` file with pip install.
1730
```sh
18-
# install after downloading
19-
cd (PATH of the download)
20-
(e.g. macOS: /Users/{NAME}/Downloads/EVE_tools;
21-
Windows: C:\Users\{NAME}\Downloads\EVE_tools)
31+
cd path/to/your/download/EVE_tools-master
2232

2333
pip3 install -r requirements.txt
2434
```
25-
#### 3. Run `example.py` by:
2635

27-
* double clicking it (in Windows)
28-
* or go to a Python IDE to launch it
29-
* or possibly:
36+
#### 1.3 Setup
3037
```sh
31-
python3 examples.py
38+
python setup.py install
3239
```
33-
* or maybe try with
40+
-----
41+
### 2. Try with `example.py`
42+
43+
Download `examples.py`, run it by:
44+
* double clicking it (in Windows)
45+
* or go to a Python IDE to launch it
46+
* or
3447
```sh
3548
python examples.py
3649
```
50+
You will see the result `hauling.csv` generated in the same directory as `examples.py`.

0 commit comments

Comments
 (0)