Skip to content

Commit ca29a19

Browse files
committed
Add -h alias to CLI '--help'
Update README.md
1 parent 977893c commit ca29a19

File tree

2 files changed

+26
-17
lines changed

2 files changed

+26
-17
lines changed

README.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -97,20 +97,11 @@ Set 'Security & Privacy' settings if needed.
9797

9898
##### Windows:
9999

100-
* Download Zadig: [https://zadig.akeo.ie/](https://zadig.akeo.ie/)
101-
* Open GoldLeaf.
102-
* Connect NS to PC
103-
* Open Zadig
104-
* Click 'Options' and select 'List All Devices'
105-
* Select NS in drop-down, select 'libusbK (v3.0.7.0)' (version may vary), click 'Install Driver' (see screenshot below)
106-
* Check that in device list of you system you have 'libusbK USB Devices' folder and your NS inside of it
107100
* [Download and install Java JRE](http://java.com/download/) (8u60 or higher)
108-
* Get this application (JAR file) double-click on on it (alternatively open 'cmd', go to place where jar located and execute via `java -jar thisAppName.jar`)
109-
* Remember to have fun!
110-
111-
![Zadig driver install example for homebrew mode](https://live.staticflickr.com/65535/49856252581_9fc5a913bb_o.png) (That's how it looks before and after)
112-
113-
NOTE: You also have to install drivers for RCM device in case you're going to use RCM functions. For installation please connect NS in RCM mode enabled and repeat steps ('USB ID' will be different).
101+
* Get this application (JAR file) and double-click on on it (alternatively open 'cmd', go to place where jar located and execute via `java -jar thisAppName.jar`)
102+
* Once application opens click on 'Gear' icon.
103+
* Click 'Download and install drivers'
104+
* Install drivers
114105

115106
#### And how to use it?
116107

@@ -122,7 +113,7 @@ Take a look on app, find where is the option to install from USB and/or Network.
122113

123114
There are three tabs. First one is main.
124115

125-
##### First tab.
116+
##### 'List' tab.
126117

127118
At the top of you selecting from drop-down application and protocol that you're going to use. For GoldLeaf only USB is available. Lamp icon stands for switching themes (light or dark).
128119

@@ -138,18 +129,36 @@ For GoldLeaf v0.6.1 and NS-USBloader v0.6 (and higher) you will have to use 'Exp
138129

139130
Also, for GoldLeaf write files (from NS to PC): You have to 'Stop execution' properly before accessing files transferred from GL. Usually you have to wait 5sec or less. It will guarantee that your files properly written to PC.
140131

141-
##### Second tab.
132+
##### 'RCM' tab
133+
134+
On this tab you can select payloader like Hekate or LockPick_RCM and send it to NS. Drag-n-drop supported. Also some in-app validations for payload takes place ;)
135+
136+
##### 'Folder with arrows and zeroes' tab
137+
138+
On this tab you can split and merge files. Select 'Split' or 'Merge' and split (or merge).
139+
140+
##### 'Gears' tab.
142141

143142
Here you can configure settings for network file transmission. Usually you shouldn't change anything. But it you're cool hacker, go ahead! The most interesting option here is 'Don't serve requests'. Architecture of the TinFoil's NET part is working interesting way. When you select in TF network NSP transfer, application will wait at port 2000 for the information about where should it take files from. Like '192.168.1.5:6060/my file.nsp'. Usually NS-USBloader serves requests by implementing simplified HTTP server and bringing it up and so on. But if this option selected, you can define path to remote location of the files. For example if you set in settings '192.168.4.2:80/ROMS/NS/' and add in table file 'my file.nsp' then NS-USBloader will simply tell TinFoil "Hey, go take files from '192.168.4.2:80/ROMS/NS/my%20file.nsp' ". Of course you have to bring '192.168.4.2' host up and make file accessible from such address (just go install nginx). As I said, this feature is interesting, but I guess won't be popular.
144143

145144
Also here you can:
146145
* Set 'Auto-check for updates' for checking for updates when application starts, or click button to verify if new version released immediately.
147146
* Set 'Show only *.nsp in GoldLeaf' to filter all files displayed at HOME:/ drive. So only NSP files will appear.
148147

149-
##### Third tab.
148+
##### 'Dialog with three dots' tab.
150149

151150
That's where all logs dropped. Verbose information about transmissions comes here.
152151

152+
153+
154+
##### CLI (command line interface)
155+
156+
```
157+
-c, --clean Remove/reset settings and exit
158+
-v, --version Show application version
159+
-h, --help Shows this message
160+
```
161+
153162
### Known bugs
154163
* 'NET' once started it never ends:
155164

src/main/java/nsusbloader/NSLMain.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ private static boolean handleCli(String[] args){
108108
System.out.println("CLI Usage:\n"
109109
+ "\t-c, --clean\tRemove/reset settings and exit\n"
110110
+ "\t-v, --version \tShow application version\n"
111-
+ "\t--help\t\tShow this message");
111+
+ "\t-h, --help\t\tShow this message");
112112
return true;
113113
default:
114114
return false;

0 commit comments

Comments
 (0)