Skip to content

Commit be6c4db

Browse files
author
pcummuskey
committed
Added some readme content.
1 parent c679a11 commit be6c4db

1 file changed

Lines changed: 82 additions & 0 deletions

File tree

README.adoc

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
Git Script Manager
2+
==================
3+
:author: Peter Cummuskey
4+
:email: peterc@aetheric.co.nz
5+
6+
This utility will allow you to manage your git scripts in a less-than-horrible
7+
fashion.
8+
9+
== Commands
10+
11+
There are a few commands for dealing with the repos and symlinks.
12+
13+
=== get
14+
15+
Fetches, updates, and/or checks-out a branch of a provided github repository.
16+
17+
e.g. git scripts get tzrlk/git-extras master
18+
19+
NOTE: If the last argument is omitted, it will default to 'master'
20+
21+
TODO: Remove reliance on github.
22+
23+
=== on
24+
25+
Selects a particular script and symlinks it into the ~/.git/script-bin
26+
directory for use.
27+
28+
e.g. git scripts on tzrlk/git-extras bin/git-ignore git-ignore
29+
30+
TODO: Make the last argument optional
31+
32+
TODO: Automatically 'get' repo if not alread fetched (only with option)
33+
34+
TODO: Add recursive searching for scripts so the subdir doesn't need to be
35+
specified.
36+
37+
=== off
38+
39+
Removes a particular script from use.
40+
41+
e.g. git scripts off git-ignore
42+
43+
=== purge
44+
45+
Removes a script repo and all associated activated scripts.
46+
47+
e.g. git scripts purge tzrlk/git-extras
48+
49+
TODO: Make this more than an rm -rf on the repo dir. Should clean-up symlinks.
50+
51+
=== list
52+
53+
Lists all the script repos, their scripts, and whether they are activated or
54+
not.
55+
56+
e.g. git scripts list
57+
58+
TODO: Actually add recursive script search and matching. Ugh.
59+
60+
== Installation
61+
62+
Scripts are provided for installation, but for any environment, the first step
63+
is to clone this repository to some directory on your computer.
64+
65+
=== Windows
66+
67+
Execute install.cmd and it will use powershell to create the correct PATH
68+
entries for you.
69+
70+
NOTE: This doesn't actually work at the moment, so you'll need to start a
71+
powershell session under administrator mode, and set the ExecutionPolicy to
72+
Bypass; finally, run the script file. The install.cmd file just attempts to do
73+
this all for you.
74+
75+
=== Linux
76+
77+
I haven't written the install scripts for linux yet.
78+
79+
=== Manual
80+
81+
Just add the bin directory and ~/.git/script-bin to your PATH. That's it.
82+

0 commit comments

Comments
 (0)