Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

readme tweaks

  • Loading branch information...
commit cfad9fa9440057aabf8502f1a66e84d489bab29c 1 parent 1386b3e
@jcw authored
Showing with 18 additions and 23 deletions.
  1. +18 −23 README.md
View
41 README.md
@@ -1,36 +1,31 @@
About {#index}
=====
-Work in progress - see <http://forum.jeelabs.net/node/457>
+**EtherCard** is a driver for the ENC28J60 chip, compatible with Arduino IDE.
-Derived from code by Guido Socher and Pascal Stang, hence under GPL2 license.
-
-The home page for this library is <http://jeelabs.org/ethercard>
+Work in progress - see [this discussion][1] for some background info.
-You can download this project in either
-[zip](https://github.com/jcw/ethercard/zipball/master) or
-[tar](https://github.com/jcw/ethercard/tarball/master) formats.
+Derived from code by Guido Socher and Pascal Stang, hence under GPL2 license.
-Unpack the archive and rename the result to `EtherCard`.
-Put it in the `libraries` folder in your Arduino sketches area.
-Restart the Arduino IDE to make sure it sees the new files.
+----
-Updates by Andrew Lindsay, December 2011:
+The latest source code for this project is maintained on [GitHub][2].
-1. Add alternative begin with 3rd parameter to specify CS pin to use. Only 8, 9 and 10 are usable.
-Default without 3rd parameter is pin 8.
+You can download all the project source files in [ZIP][3] or [TAR][4] format:
-2. Updated DHCP to allow broadcast packets to be received as some DHCP servers (Some Linux and
-Windows DHCP servers) send responses to mac address ff:ff:ff:ff:ff:ff which would otherwise be
-filtered out. At end of DHCP process the broadcast filter is returned to block broadcast packets.
-ARP broadcasts are not affected as they have their own filter.
+* Unpack the archive and rename the resulting folder to "EtherCard".
+* Move it to the "libraries" folder in your Arduino sketches area.
+* Restart the Arduino IDE to make sure it sees the new files.
-3. Cleared up a number of Arduino 1.0 IDE warnings.
+The wiki for this library is at <http://jeelabs.net/projects/cafe/wiki>.
-4. Experimental - commented out line 609 of tcpip.cpp to no longer terminate client connections
-after 1 packet has been received. This is to allow larger packets and streamed data to be received.
-However, this may not terminate connections correctly. It needs more work to decide if other host
-is wanting to close connection. To remove this feature, remove the comment characters // on line 609.
+The API documentation is generated by Doxygen and can be found [here][5].
+For questions and reporting bugs, check out the JeeLabs [forums][6].
-
+[1]: http://forum.jeelabs.net/node/457
+[2]: https://github.com/jcw/ethercard
+[3]: https://github.com/jcw/ethercard/zipball/master
+[4]: https://github.com/jcw/ethercard/tarball/master
+[5]: http://jeelabs.net/pub/docs/ethercard/
+[6]: http://forum.jeelabs.net/forum
Please sign in to comment.
Something went wrong with that request. Please try again.