Added contribution guide and updated readme

Author: kollokollo

CONTRIBUTING.md

@@ -0,0 +1,60 @@
+Guide to contributing to the Arduino Floppy Disk Controller
+===========================================================
+
+The Arduino firmware is already very useful und can read everything.
+The track is always read at-once, because the sector-wise reading depends
+on the format (AMIGA, PC, ATARI, COMMODORE etc..). Letting the format be 
+detected by PC software is part of the concept, and sufficiently smart, 
+so this need not be changed. To read a single sector, the PC software can 
+instruct the Arduino formware to read the whole track, and then it can 
+decode only a single sector. There are options to wait or not wait for the 
+index pulse when reading, so that even a fast reading should be possible.
+
+Improvements can be done with writing to the disk. Here contributions are 
+welcome.
+
+However writing is olnly supported for DD track-at once currently. Since the 
+Arduino cannot buffer the data for a whole track, the writing need do be 
+in sync with data arriving via the serial interface. This is a bit tricky 
+and does not always work. Writing a track at once is the normal way to either
+* format the disk (ATARI ST, PC) or
+* write data to it (AMIGA).
+Writing individual Sectors should maybe made possible in furture (and a single 
+sector data can well be buffered by the firmware). But sector detection is 
+format dependant. Luckily for the ATARI ST and PC disks the sector marks 
+are the same. COMMODORE disks will maybe later be supported. 
+
+
+Other ideas: 
+* How about a block device driver for linux (interfacinge the Arduino firmware)?
+
+## License and attribution
+
+All contributions must be properly licensed and attributed. If you are contributing your own original work, then you are offering it under a CC-BY license (Creative Commons Attribution). If it is code, you are offering it under the GPL-v2. You are responsible for adding your own name or pseudonym in the Acknowledgments file, as attribution for your contribution.
+
+If you are sourcing a contribution from somewhere else, it must carry a compatible license. The project was initially released under the GNU public licence GPL-v2 which means that contributions must be licensed under open licenses such as MIT, CC0, CC-BY, etc. You need to indicate the original source and original license, by including a comment above your contribution. 
+
+## Contributing with a Pull Request
+
+The best way to contribute to this project is by making a pull request:
+
+1. Login with your Github account or create one now
+2. [Fork](https://github.com/kollokollo/ArduinoFloppyDiskReader#fork-destination-box) the ArduinoFloppyDiskReader repository. Work on your fork.
+3. Create a new branch on which to make your change, e.g.
+`git checkout -b my_code_contribution`, or make the change on the `new` branch.
+4. Edit the file where you want to make a change or create a new file in the `contrib` directory if you're not sure where your contribution might fit.
+5. Edit `ACKNOWLEGEMENTS` and add your own name to the list of contributors under the section with the current year. Use your name, or a github ID, or a pseudonym.
+6. Commit your change. Include a commit message describing the correction.
+7. Submit a pull request against the ArduinoFloppyDiskReader repository.
+
+
+## Contributing with an Issue
+
+If you find a mistake and you're not sure how to fix it, or you don't know how to do a pull request, then you can file an Issue. Filing an Issue will help us see the problem and fix it.
+
+Create a [new Issue](https://github.com/kollokollo/ArduinoFloppyDiskReader/issues/new) now!
+
+
+## Thanks
+
+We are very grateful for your support. With your help, this implementation will be a great project. 

README.md

@@ -0,0 +1,63 @@
+# Arduino Powered Floppy Disk Reader and Writer
+Created by Robert Smith @RobSmithDev
+with interfaces for Amiga, ATARI ST and DOS/PC Disk formats.
+
+# What is it?
+This project uses an Arduino to interface with a floppy disk drive and 
+communicate with a PC in order to recover the data from any formatted 
+disks. The drive can be either a 8", 5 1/4" or 3 1/2" standard floppy drive.
+It was tested on a 3 1/2" standard PC floppy drive. Others (like the 
+5 1/4" standard PC floppy drive) my also work without modifications.
+
+This configration can read SD, DD and HD floppy disk formats 
+(AMIGA, ATARI ST, PC DOS, COMMODORE C64) 
+and maybe more. 
+
+The Arduino firmware allows to read the raw data from each track of the
+floppy. Decoding of the sector data is done on the PC. Usually a floppy image
+file is created (ADF for AMIGA, .img for ATARI ST and PC/DOS).
+
+It also allows you to write a backed up ADF file back onto a floppy disk!
+
+# ArduinoFloppyReader
+This Visual Studio 2017 project contains two applications, a command line, 
+and a Windows dialog based application
+
+# Scripts for linux
+The ATARI ST and DOS/PC floppy formats can be decoded whith these scripts.
+9,10,11 or 18 Sectors per track. Up to 82 tracks, DD (ca. 800 kBytes) or 
+HD (1.4 MBytes). The images usually contain a FAT12 file system which can be 
+directly mounted by linuy without any additional driver.   
+Sorry, no interface to WINDOWS yet. 
+
+# FloppyDriverController.sketch
+This is the Ardunio source code/sketch for all Floppy formats.
+* Detect disk density (SD/DD or HD)
+* Motor ON/OFF
+* Seek to Track 0
+* Seek to any track (up to 82)
+* read write protection status
+* Read index pulse
+* read raw track data (FM, MFM; SD, DD or HD)
+* write track data (unbuffered, only DD yet)
+
+# AVR Firmware
+If you want to use the AVR directly instead of within the Arduino environment, 
+then jump to [https://github.com/jtsiomb/usbamigafloppy] where John Tsiombikas 
+has ported the code.
+
+# Help and Instructions 
+For further details including how to wire this up please visit 
+[http://amiga.robsmithdev.co.uk]
+
+# Whats changed?
+V2.2 Fixed 99% of checksum errors when writing by erasing the track first
+V2.1 Diagnostics and potential write bug fixed
+V2.0 Disk reading has been vastly improved and you can now also write disks!
+V1.0 Initial release, can read disks fairly well
+
+# Licence
+
+This entire project is available under the GNU General Public License v3
+licence.  See licence.txt for more details.
+