|
@@ -18,7 +18,7 @@ The following scripts can be used on any system with a GNU environment to speed
|
18
|
18
|
|
19
|
19
|
File|Description
|
20
|
20
|
----|-----------
|
21
|
|
-mfadd [user]|Add and Fetch Remote - Add another Github user's fork of Marlin as a remote, then fetch it. Optionally, check out one of their branches.
|
|
21
|
+mfadd [user]|Add and Fetch Remote - Add and fetch another user's Marlin fork. Optionally, check out one of their branches.
|
22
|
22
|
mfinit|Init Working Copy - Create a remote named '`upstream`' (for use by the other scripts) pointing to the '`MarlinFirmware`' fork. This only needs to be used once. Newer versions of Github Desktop may create `upstream` on your behalf.
|
23
|
23
|
|
24
|
24
|
#### Branches
|
|
@@ -41,14 +41,15 @@ mfqp|Quick Patch - Commit all current changes as "patch", then do `mfrb`, follow
|
41
|
41
|
|
42
|
42
|
File|Description
|
43
|
43
|
----|-----------
|
44
|
|
-mfdoc|Build the documentation and preview it locally.
|
45
|
|
-mfpub|Build the documentation and publish it to marlinfw.org via Github.
|
|
44
|
+mfdoc|Build the documentation with Jekyll and preview it locally.
|
|
45
|
+mfpub|Build and publish the documentation to marlinfw.org.
|
46
|
46
|
|
47
|
47
|
#### Utilities
|
48
|
48
|
|
49
|
49
|
File|Description
|
50
|
50
|
----|-----------
|
51
|
51
|
ghtp -[h/s]|Set the protocol to use for all remotes. -h for HTTPS, -s for SSL.
|
|
52
|
+ghpc [-f]|Push current branch to 'origin' or to the remote indicated by the error.
|
52
|
53
|
mfinfo|This utility script is used by the other scripts to get:<br/>- The upstream project ('`MarlinFirmware`')<br/>- the '`origin`' project (i.e., your Github username),<br/>- the repository name ('`Marlin`'),<br/>- the PR target branch ('`bugfix-1.1.x`'), and<br/>- the current branch (or the first command-line argument).<br/><br/>By itself, `mfinfo` simply prints these values to the console.
|
53
|
54
|
mfclean |Prune your merged and remotely-deleted branches.
|
54
|
55
|
|
|
@@ -56,4 +57,4 @@ mfclean |Prune your merged and remotely-deleted bra
|
56
|
57
|
|
57
|
58
|
### Examples
|
58
|
59
|
|
59
|
|
-Coming Soon!
|
|
60
|
+For a demonstration of these scripts see the video [Marlin Live - May 9 2019](https://youtu.be/rwT4G0uVTIY). There is also an old write-up at [#3193](https://github.com/MarlinFirmware/Marlin/issues/3193).
|