Add initial README and license

Author: rasky

LICENSE.mit

@@ -0,0 +1,18 @@
+Copyright 2019 Giovanni Bajo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,65 @@
+## g64drive - a Linux/Mac tool for operating 64drive by Retroactive
+
+### Installation (binary)
+
+g64drive ships as a static binary on both Linux and macOS, with no additional dependencies
+required. Just download it and put it in your `PATH` (eg: `/usr/local/bin`) .
+
+### Installation (source)
+
+Make sure you have Go 1.12 or newer installed on your system. To download, compile and install
+g64drive from source code, simply run:
+
+```
+    $ GO111MODULE=on go build github.com/rasky/g64drive
+```
+
+### Usage quicksheet
+
+Make sure you can reach your 64drive:
+```
+    $ g64drive list -v
+    Found 1 64drive device(s):
+    * 0: Retroactive 64drive USB device (serial: RA3B53SW)
+      -> Hardware: HW2 (Rev B), Firmware: 2.05
+```
+
+Upload a ROM to the CARTROM bank (with byteswap and CIC type autodetection):
+```
+    $ g64drive upload myrom.v64 -v
+    64drive serial: RA3B53SW
+    upload bank: BankCARTROM
+    byteswap: 2
+    size: 33554432
+    offset: 0
+    myrom.z64 100% |████████████████████████████████████████|  [1s:0s]
+```
+
+Download data from the CARTROM bank:
+```
+    $ g64drive download myrom.v64 -v --size 32M
+    64drive serial: RA3B53SW
+    download bank: BankCARTROM
+    byteswap: 0
+    size: 33554432
+    offset: 0
+    myrom.z64 100% |████████████████████████████████████████|  [1s:0s]
+```
+
+### Features
+
+ * Support 64drive HW1 and HW2
+ * Upload and download data from any available bank
+ * Transparent byteswapping (with autodetection from ROM header)
+ * Transparent CIC detection when uploading a ROM
+ * Can specify sizes and offsets in decimale, hex, or even kilobytes/megabytes
+ * CTRL+C clean shutdown -- doesn't need to power-cycle 64drive after it
+ * Shipped as static binary, very easy to install on any Linux and macOS system
+
+What's missing:
+ * Firmware upgrades
+ * Standalone mode
+
+### Bugs?
+
+Please [file an issue](https://github.com/rasky/g64drive/issues/new) on GitHub.