]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS-Plus/Source/FreeRTOS-Plus-TCP/readme.txt
Added +TCP code to main repo.
[freertos] / FreeRTOS-Plus / Source / FreeRTOS-Plus-TCP / readme.txt
diff --git a/FreeRTOS-Plus/Source/FreeRTOS-Plus-TCP/readme.txt b/FreeRTOS-Plus/Source/FreeRTOS-Plus-TCP/readme.txt
new file mode 100644 (file)
index 0000000..a90fb9e
--- /dev/null
@@ -0,0 +1,18 @@
+Contains the files that implement FreeRTOS+TCP.\r
+\r
+User documentation, including an API reference is available on:\r
+http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/\r
+\r
+A description of the source code organisation is available on:\r
+http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/TCP_Networking_Tutorial.html\r
+\r
+The porting guide is available on:\r
+http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/FreeRTOS_TCP_Porting.html\r
+\r
+License information is available on:\r
+http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/FreeRTOS_Plus_TCP_License.html\r
+\r
+At this time it is recommended to use BufferAllocation_2.c in which case it is\r
+essential to use the heap_4.c memory allocation scheme:\r
+http://www.FreeRTOS.org/a00111.html\r
+\r