File tree Expand file tree Collapse file tree 1 file changed +15
-7
lines changed Expand file tree Collapse file tree 1 file changed +15
-7
lines changed Original file line number Diff line number Diff line change 1
1
# git-scribe
2
2
3
3
<p align =" center " >
4
- <img src =" https://raw.githubusercontent.com/popyson1648/git-llm /main/logo.png " alt =" git-scribe logo " width =" 200 " />
4
+ <img src =" https://raw.githubusercontent.com/popyson1648/git-scribe /main/logo.png " alt =" git-scribe logo " width =" 200 " />
5
5
</p >
6
6
7
7
<p align =" center " >
34
34
35
35
## Demo
36
36
37
- ![ Demo of git-scribe in action] ( assets/demo.gif )
37
+ ![ Demo of git-scribe in action] ( https://raw.githubusercontent.com/popyson1648/git-scribe/main/ assets/demo.gif)
38
38
39
39
## Features
40
40
54
54
55
55
### 1. Install ` git-scribe `
56
56
57
- You can install the tool directly from this GitHub repository :
57
+ You can install the tool from PyPI :
58
58
59
59
``` bash
60
- pip install git+https://github.com/popyson1648/git-llm. git
60
+ pip install popyson- git-scribe
61
61
```
62
62
63
- * (Note: Once published to PyPI, this will become ` pip install git-scribe ` )*
63
+ Alternatively, you can install it directly from the GitHub repository for the latest development version:
64
+
65
+ ``` bash
66
+ pip install git+https://github.com/popyson1648/git-scribe.git
67
+ ```
64
68
65
69
### 2. Initial Setup
66
70
@@ -159,11 +163,15 @@ Contributions are welcome! Please feel free to open an issue or submit a pull re
159
163
160
164
1 . Clone the repository.
161
165
2 . Create a virtual environment and activate it.
162
- 3 . Install the package in editable mode with development dependencies:
166
+ 3 . Install pre-commit hooks:
167
+ ``` bash
168
+ pre-commit install
169
+ ```
170
+ 4. Install the package in editable mode with development dependencies:
163
171
` ` ` bash
164
172
pip install -e .[dev]
165
173
` ` `
166
- 4 . Run tests:
174
+ 5 . Run tests:
167
175
` ` ` bash
168
176
pytest
169
177
` ` `
You can’t perform that action at this time.
0 commit comments