Skip to content

Commit b0d1e5d

Browse files
committed
📝 Updates documentation with Pip related instructions
1 parent 367f4bc commit b0d1e5d

File tree

1 file changed

+14
-74
lines changed

1 file changed

+14
-74
lines changed

.github/README.md

Lines changed: 14 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Runs command or callback function when path file modified time changes
2020

2121
- [:zap: Quick Start][heading__quick_start]
2222

23-
- [:memo: Edit Your ReadMe File][heading__your_readme_file]
23+
- [:memo: Your Requirements File][heading__your_requirements_file]
2424
- [:floppy_disk: Commit and Push][heading__commit_and_push]
2525
- [🧰 Usage][heading__usage]
2626

@@ -53,54 +53,25 @@ ___
5353
"⚡ Perhaps as easy as one, 2.0,..."
5454

5555

56-
When utilizing this repository within other projects Git Submodules to track dependencies are encouraged
57-
58-
59-
**Bash Variables**
56+
Install this project via Pip version 2 or 3
6057

6158

6259
```Bash
63-
_module_name='watch_path'
64-
_module_https_url="https://github.com/python-utilities/watch_path.git"
65-
_module_base_dir='modules'
66-
_module_path="${_module_base_dir}/${_module_name}"
67-
```
68-
69-
70-
**Bash Submodule Commands**
71-
72-
73-
```Bash
74-
cd "<your-git-project-path>"
75-
76-
mkdir -vp "${_module_base_dir}"
77-
78-
git submodule add\
79-
-b master --name "${_module_name}"\
80-
"${_module_https_url}" "${_module_path}"
60+
pip3 install --user --upgrade watch-path
8161
```
8262

8363

84-
### Your ReadMe File
85-
[heading__your_readme_file]:
86-
#your-readme-file
87-
"&#x1F4DD; Suggested additions for your ReadMe.md file so everyone has a good time with submodules"
88-
89-
90-
Suggested additions for your _`ReadMe.md`_ file so everyone has a good time with submodules
91-
92-
93-
```MarkDown
94-
Clone with the following to avoid incomplete downloads
64+
### Your Requirements File
65+
[heading__your_requirements_file]:
66+
#your-requirements-file
67+
"&#x1F4DD; Suggested additions for your requirements.txt file so everyone has a good time with dependencies"
9568

9669

97-
git clone --recurse-submodules <url-for-your-project>
70+
Suggested additions for your requirements.txt file so everyone has a good time with dependencies
9871

9972

100-
Update/upgrade submodules via
101-
102-
103-
git submodule update --init --merge --recursive
73+
```txt
74+
watch-path
10475
```
10576

10677

@@ -111,26 +82,14 @@ Update/upgrade submodules via
11182

11283

11384
```Bash
114-
git add .gitmodules
115-
git add "${_module_path}"
116-
117-
118-
## Add any changed files too
85+
git add requirements.txt
11986

12087

12188
git commit -F- <<'EOF'
122-
:heavy_plus_sign: Adds `python-utilities/watch_path#1` submodule
89+
:heavy_plus_sign: Adds `python-utilities/watch_path#1` as dependency
12390
12491
125-
126-
**Additions**
127-
128-
129-
- `.gitmodules`, tracks submodules AKA Git within Git _fanciness_
130-
131-
- `README.md`, updates installation and updating guidance
132-
133-
- `modules/watch_path`, Runs command or callback function when watched path modified time changes
92+
## Anything else worth committing
13493
EOF
13594

13695

@@ -150,26 +109,7 @@ git push
150109
"&#x1F9F0;"
151110

152111

153-
Example of running as command-line utility...
154-
155-
156-
- _Installation_
157-
158-
159-
```Bash
160-
mkdir -p ~/git/hub/python-utilities/watch_path
161-
162-
cd ~/git/hub/python-utilities/watch_path
163-
164-
git clone https://github.com/python-utilities/watch_path.git
165-
166-
mkdir -p ~/bin
167-
168-
ln -s "${HOME}/git/hub/python-utilities/watch_path/watch_path.py" "${HOME}/bin/watch_path"
169-
```
170-
171-
172-
- Print available commands
112+
- Print available CLI (Command Line Interface) options
173113

174114

175115
```Bash

0 commit comments

Comments
 (0)