move the netutils README file from 'netutils' to 'external/include'
authorkang <pilseob.kang@samsung.com>
Sat, 2 Sep 2017 06:35:58 +0000 (15:35 +0900)
committerkang <pilseob.kang@samsung.com>
Sat, 2 Sep 2017 06:35:58 +0000 (15:35 +0900)
apps/netutils/README.txt
external/include/json/README.txt [new file with mode: 0644]
external/include/protocols/README.txt [new file with mode: 0644]

index 68be53c..454ab5a 100644 (file)
@@ -1,4 +1,4 @@
-netutils README.txt
+protocols README.txt
 ^^^^^^^^^^^^^^^^^^^
 
 Contents
@@ -15,41 +15,41 @@ These applications are not all heavily tested.
 Apps include:
 
   dhcpc     - Dynamic Host Configuration Protocol (DHCP) client.
-              See external/dhcpc.h for interface information.
+              See external/include/protocols/dhcpc.h for interface information.
   dhcpd     - Dynamic Host Configuration Protocol (DHCP) server.
-              See apps/include/netutils/dhcpd.h for interface information.
+              See external/include/protocols/dhcpd.h for interface information.
   ftpc      - FTP client.
-              See apps/include/ftpc.h for interface information.
+              See external/include/protocols/ftpc.h for interface information.
   ftpd      - FTP server.
-              See apps/include/netutils/ftpd.h for interface information.
-  json      - cJSON is an ultra-lightweight, portable, single-file,
-              simple-as-can-be ANSI-C compliant JSON parser, under MIT license.
-              Embeddable Lightweight XML-RPC Server discussed at
-              http://www.drdobbs.com/web-development/an-embeddable-lightweight-xml-rpc-server/184405364.
-              See apps/include/netutils/cJSON.h for interface information.
+              See external/include/protocols/ftpd.h for interface information.
   mdns      - multicast Domain Name System (mDNS).
               See external/mdns/mdns.h for interface information.
   netlib    - network libraries that includes IP address support, HTTP support and generic server logic.
               See external/netlib.h for interface information.
   ntpclient - This is a fragmentary NTP client. It neither well-tested
               nor mature nor complete at this point in time.
-              See apps/include/netutils/ntpclient.h for interface information.
+              See external/include/protocols/ntpclient.h for interface information.
   smtp      - Simple Mail Transfer Protocol (SMTP) client.
-              See apps/include/netutils/smtp.h for interface information.
+              See external/include/protocols/smtp.h for interface information.
   telnetd   - TELNET server.
-              See apps/include/netutils/telnetd.h for interface information.
+              See external/include/protocols/telnetd.h for interface information.
   tftpc     - TFTP client.
-              See apps/include/netutils/tftp.h for interface information.
+              See external/include/protocols/tftp.h for interface information.
   webclient - HTTP web client.
-              See apps/include/netutils/webclient.h for interface information.
+              See external/include/protocols/webclient.h for interface information.
   webserver - HTTP web server.
               See os/include/external/webserver/http_server.h for interface information.
   websocket - websocket server and client.
-              See apps/include/netutils/websocket.h for interface information.
+              See external/include/protocols/websocket.h for interface information.
   xmlrpc    - The Embeddable Lightweight XML-RPC Server discussed at
               http://www.drdobbs.com/web-development/an-embeddable-lightweight-xml-rpc-server/184405364.
-              See apps/include/netutils/xmlrpc.h for interface information.
-
+              See external/include/protocols/xmlrpc.h for interface information.
+  json      - cJSON is an ultra-lightweight, portable, single-file,
+              simple-as-can-be ANSI-C compliant JSON parser, under MIT license.
+              Embeddable Lightweight XML-RPC Server discussed at
+              http://www.drdobbs.com/web-development/an-embeddable-lightweight-xml-rpc-server/184405364.
+              See external/include/protocols/cJSON.h for interface information.
+                         
 Tips for Using DHCPC
 ^^^^^^^^^^^^^^^^^^^^
 
diff --git a/external/include/json/README.txt b/external/include/json/README.txt
new file mode 100644 (file)
index 0000000..8147952
--- /dev/null
@@ -0,0 +1,9 @@
+json README.txt
+^^^^^^^^^^^^^^^^^^^
+
+  json      - cJSON is an ultra-lightweight, portable, single-file,
+              simple-as-can-be ANSI-C compliant JSON parser, under MIT license.
+              Embeddable Lightweight XML-RPC Server discussed at
+              http://www.drdobbs.com/web-development/an-embeddable-lightweight-xml-rpc-server/184405364.
+              See external/include/protocols/cJSON.h for interface information.
+
diff --git a/external/include/protocols/README.txt b/external/include/protocols/README.txt
new file mode 100644 (file)
index 0000000..63f9b6f
--- /dev/null
@@ -0,0 +1,52 @@
+protocols README.txt
+^^^^^^^^^^^^^^^^^^^
+
+Contents
+--------
+
+  - Network Applications
+  - Tips for Using DHCPC
+
+Network Applications
+^^^^^^^^^^^^^^^^^^^^
+
+This directory contains most of the network applications.
+These applications are not all heavily tested.
+Apps include:
+
+  dhcpc     - Dynamic Host Configuration Protocol (DHCP) client.
+              See external/include/protocols/dhcpc.h for interface information.
+  dhcpd     - Dynamic Host Configuration Protocol (DHCP) server.
+              See external/include/protocols/dhcpd.h for interface information.
+  ftpc      - FTP client.
+              See external/include/protocols/ftpc.h for interface information.
+  ftpd      - FTP server.
+              See external/include/protocols/ftpd.h for interface information.
+  mdns      - multicast Domain Name System (mDNS).
+              See external/mdns/mdns.h for interface information.
+  netlib    - network libraries that includes IP address support, HTTP support and generic server logic.
+              See external/netlib.h for interface information.
+  ntpclient - This is a fragmentary NTP client. It neither well-tested
+              nor mature nor complete at this point in time.
+              See external/include/protocols/ntpclient.h for interface information.
+  smtp      - Simple Mail Transfer Protocol (SMTP) client.
+              See external/include/protocols/smtp.h for interface information.
+  telnetd   - TELNET server.
+              See external/include/protocols/telnetd.h for interface information.
+  tftpc     - TFTP client.
+              See external/include/protocols/tftp.h for interface information.
+  webclient - HTTP web client.
+              See external/include/protocols/webclient.h for interface information.
+  webserver - HTTP web server.
+              See os/include/external/webserver/http_server.h for interface information.
+  websocket - websocket server and client.
+              See external/include/protocols/websocket.h for interface information.
+  xmlrpc    - The Embeddable Lightweight XML-RPC Server discussed at
+              http://www.drdobbs.com/web-development/an-embeddable-lightweight-xml-rpc-server/184405364.
+              See external/include/protocols/xmlrpc.h for interface information.
+
+Tips for Using DHCPC
+^^^^^^^^^^^^^^^^^^^^
+
+If you use DHCPC, this configuration network option is required.
+  CONFIG_NETUTILS_DHCPC=y