Skip to content

Commit 95e75f6

Browse files
committed
Update development and release documentation
1 parent b9a803a commit 95e75f6

2 files changed

Lines changed: 15 additions & 7 deletions

File tree

docs/development.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Development
1+
# Development Environment Setup
22

33
## Setup
44

@@ -19,7 +19,7 @@ source venv/bin/activate
1919
Install the required packages:
2020

2121
```bash
22-
pip install -r requirements.txt
22+
pip install pypsrp[kerberos]==0.8.1 prompt_toolkit==3.0.51 tqdm==4.67.1
2323
```
2424

2525
## Create a test file

docs/release.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,26 @@ python3 -m pip install --upgrade twine
1616
__version__ = "X.Y.Z" # update this to the new version
1717
```
1818

19-
## Build
19+
## Sceenshot
20+
21+
Creating screenshots for the README using the [freeze](https://github.com/charmbracelet/freeze) tool.
2022

2123
```bash
22-
python3 -m build
24+
freeze --execute "evil-winrm-py -h" -o assets/terminal.png --padding 5 --border.radius 4 # --wrap 120
2325
```
2426

25-
# Sceenshot
27+
Update the screenshot tag in the README file.
2628

27-
Creating screenshots for the README using the [freeze](https://github.com/charmbracelet/freeze) tool.
29+
```diff
30+
# File: evil_winrm_py/README.md
31+
-![](https://raw.githubusercontent.com/adityatelange/evil-winrm-py/refs/tags/v1.4.0/assets/terminal.png)
32+
+![](https://raw.githubusercontent.com/adityatelange/evil-winrm-py/refs/tags/v1.4.1/assets/terminal.png)
33+
```
34+
35+
## Build
2836

2937
```bash
30-
freeze --execute "evil-winrm-py -h" -o assets/terminal.png --padding 5 --wrap 120 --border.radius 4
38+
python3 -m build
3139
```
3240

3341
## Upload

0 commit comments

Comments
 (0)