README update. Fixing some typos.

This commit is contained in:
Dmitry Isaenko 2019-02-19 00:04:58 +03:00
parent d3b25d57b1
commit 6198b52ca5

View file

@ -1,6 +1,6 @@
# NS-USBloader # NS-USBloader
NS-USBloader is a PC-side TinFoil/GoldLeaf NSP USB uploader. Replacement for default usb_install_pc.py and GoldTree. NS-USBloader is a PC-side TinFoil and GoldLeaf NSP USB uploader. Replacement for default *usb_install_pc.py* and *GoldTree*.
With GUI and cookies. With GUI and cookies.
@ -8,27 +8,28 @@ Read more: https://developersu.blogspot.com/2019/02/ns-usbloader-en.html
Here is the version of 'not perfect but anyway' [tinfoil I use](https://cloud.mail.ru/public/DwbX/H8d2p3aYR). Here is the version of 'not perfect but anyway' [tinfoil I use](https://cloud.mail.ru/public/DwbX/H8d2p3aYR).
Ok, I'm almost sure that this version has bugs. I don't remember where I downloaded it. But it works for me somehow.. Ok, I'm almost sure that this version has bugs. I don't remember where I downloaded it. But it works for me somehow..
Let's rephrase, if you have working version of TinFoil DO NOT use this one. Let's rephrase, if you have working version of TinFoil DO NOT use this one.
## License ## License
Source code spreads under the GNU General Public License v.3. You can find it in LICENSE file. Source code spreads under the GNU General Public License v.3. You can find it in LICENSE file.
## Requirements
JRE 8 or higher. See below.
## Used libraries ## Used libraries
* [OpenJFX](https://wiki.openjdk.java.net/display/OpenJFX/Main) * [OpenJFX](https://wiki.openjdk.java.net/display/OpenJFX/Main)
* [usb4java](https://mvnrepository.com/artifact/org.usb4java/usb4java) * [usb4java](https://mvnrepository.com/artifact/org.usb4java/usb4java)
* Few icons taken from: [materialdesignicons](http://materialdesignicons.com/) * Few icons taken from: [materialdesignicons](http://materialdesignicons.com/)
## Requirements
JRE 8 or higher. See below.
## Usage ## Usage
### Linux: ### Linux:
Install JRE/JDK 8 or higher (openJDK is good. Oracle's one is also good). JavaFX not needed, if you're interested (it's embedded). 1. Install JRE/JDK 8 or higher (openJDK is good. Oracle's one is also good). JavaFX not needed, if you're interested (it's embedded).
`root # java -jar /path/to/NS-USBloader.jar` 2. `root # java -jar /path/to/NS-USBloader.jar`
### macOS ### macOS
@ -40,15 +41,15 @@ Set 'Security & Privacy' settings if needed.
* Download Zadig: https://zadig.akeo.ie/ * Download Zadig: https://zadig.akeo.ie/
* Open tinfoil. Set 'Title Managment' -> 'Usb install NSP' * Open tinfoil. Set 'Title Managment' -> 'Usb install NSP'
* Connect NS to pc * Connect NS to PC
* Open Zadig, select NS in dropdown, select 'libusbK (v3.0.7.0)' (version may vary), click 'Install WCID Driver' * Open Zadig, select NS in dropdown, select 'libusbK (v3.0.7.0)' (version may vary), click 'Install WCID Driver'
* Check that in device list of you system you have 'libusbK USB Devices' folder and your NS inside of it * Check that in device list of you system you have 'libusbK USB Devices' folder and your NS inside of it
* Download and install Java JRE (8+) * Download and install Java JRE (8+)
* 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') * 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`)
* Remember to have fun! * Remember to have fun!
## Tips&tricks ## Tips&tricks
### Add user to udev rules to use NS non-root (Linux): ### Linux: Add user to udev rules to use NS not-from-root-account
`root # vim /etc/udev/rules.d/99-NS.rules` `root # vim /etc/udev/rules.d/99-NS.rules`
`SUBSYSTEM=="usb", ATTRS{idVendor}=="057e", ATTRS{idProduct}=="3000", GROUP="plugdev"` `SUBSYSTEM=="usb", ATTRS{idVendor}=="057e", ATTRS{idProduct}=="3000", GROUP="plugdev"`
@ -70,6 +71,7 @@ Handling successful/failed installation is a purpose of the other side applicati
- [x] GoldLeaf support - [x] GoldLeaf support
- [ ] XCI support - [ ] XCI support
- [ ] File order sort (non-critical) - [ ] File order sort (non-critical)
- [ ] More deep file analyze before uploading.
## Thanks ## Thanks
Appreciate assistance and support of both Vitaliy and Konstantin. Without you all this magic would not have happened. Appreciate assistance and support of both Vitaliy and Konstantin. Without you all this magic would not have happened.