Skip to content

Commit c264254

Browse files
committed
Update doc
1 parent e9a113c commit c264254

File tree

3 files changed

+19
-16
lines changed

3 files changed

+19
-16
lines changed

sphinx/httpserver.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Usage
2323
2424
HttpServer http;
2525
26-
- Initialize the SD ans start the HTTP server :
26+
- Initialize the SD and start the HTTP server :
2727

2828
.. code-block:: c
2929

sphinx/installation.rst

+16
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,22 @@ FullIP is a suite of ip protocols implementation for Arduino.
2222

2323
- comment #define FULLIP_SD to disable SD or
2424
uncomment it to build ftpclient, httpserver, ...
25+
26+
- Import it in your sketch :
27+
28+
- import the Ethernet library or the UIPEthernet and the SD if needed :
29+
30+
.. code-block:: c
31+
32+
// For W5100
33+
//You must also update FullIP/FullIP.h
34+
#include <SPI.h>
35+
#include <Ethernet.h>
36+
//For enc28j60
37+
//You must also update FullIP/FullIP.h
38+
//#include <UIPEthernet.h>
39+
#include <SD.h>
40+
#include <FullIP.h>
2541
2642
- The pin CS are hardcoded in UIPEthernet and Ethernet libraires. Update the
2743
followings files if needed :

sphinx/readme.rst

+2-15
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ Welcome to FullIP
44

55
FullIP for Arduino (https://github.com/bibi21000/arduino-fullip)
66

7-
FullIP is a suite of ip protocols implementation for Arduino.
7+
FullIP is a suite of ip protocols implementation for Arduino. It's
8+
compatible with Ethernet/W5100 and UIPEthernet/ENC28j60.
89

910
Applications availables :
1011

@@ -51,20 +52,6 @@ Install FullIP:
5152

5253
In your sketch :
5354

54-
- import the Ethernet library or the UIPEthernet and the SD if needed :
55-
56-
.. code-block:: c
57-
58-
// For W5100
59-
//You must also update FullIP/FullIP.h
60-
#include <SPI.h>
61-
#include <Ethernet.h>
62-
//For enc28j60
63-
//You must also update FullIP/FullIP.h
64-
//#include <UIPEthernet.h>
65-
#include <SD.h>
66-
#include <FullIP.h>
67-
6855
- Define a client (FTP in this example)
6956

7057
.. code-block:: c

0 commit comments

Comments
 (0)