Skip to content

Commit 78946ef

Browse files
authored
Added "Getting Started" guide
1 parent d194de2 commit 78946ef

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed

README.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,65 @@ Commit: Mon Sep 30 22:00:00 EDT 2019
1313
Commit: Tue Oct 1 22:00:00 EDT 2019
1414
Commit: Wed Oct 2 22:00:00 EDT 2019
1515
```
16+
17+
This is a Bash script
18+
<br>designed to be run locally
19+
<br>right on your machine
20+
21+
> But [@theshteves](https://github.com/theshteves),
22+
> <br>I want this to run every day
23+
24+
_Oh hush_
25+
<br>Nobody commits every day
26+
27+
Is that what you want?
28+
29+
Sorry, not today 🚫
30+
31+
## Getting Started
32+
33+
If you're on Windows™,
34+
[setup the Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
35+
36+
If you haven't already, [install git](https://github.com/git-guides/install-git)**
37+
38+
1. Open your command-line
39+
<br>& navigate to whatever folder you prefer
40+
41+
2. Download this project
42+
43+
```shell
44+
git clone https://github.com/theshteves/commit-bot.git
45+
```
46+
47+
3. Test run the script
48+
<br>in case you need to fix permissions issues
49+
50+
```shell
51+
source ./commit-bot/bot.sh
52+
```
53+
54+
4. [Open your crontab](https://www.howtogeek.com/101288/how-to-schedule-tasks-on-linux-an-introduction-to-crontab-files/) to set a trigger
55+
56+
```shell
57+
crontab -e
58+
```
59+
60+
> Tip: if this makes your screen almost blank
61+
> <br>with no toolbar of keys to navigate,
62+
> <br>you've probably entered the text editor Vim
63+
> <br>
64+
> <br>Remember, press "i" to start [i]nserting text
65+
> <br>then when you're finished
66+
> <br>press "Esc" repeatedly until nothing happens
67+
> <br>& type ":wq" to save & quit
68+
> <br>or ":q!" to quit without saving
69+
70+
5. Add this line to [schedule every 10pm or whatever](https://crontab.guru/#0_22_*_*_*)
71+
72+
```shell
73+
0 22 * * * source /<full-path-to-your-folder>/commit-bot/bot.sh
74+
```
75+
76+
> Tip: Make sure you save your changes
77+
> <br>on your way out!

0 commit comments

Comments
 (0)