From 992d16a2cf646ab5f9cd88bda2c7a9b133ae5933 Mon Sep 17 00:00:00 2001 From: kushalsingh007 Date: Sat, 7 Mar 2015 21:05:47 +0530 Subject: [PATCH] Transform existing documentation for PORTING and USING to markdown - Converted the existing documentation to markdown format. - Fix for #1458. - Changes font to bold at some places to improve readability --- pkg/PORTING | 11 ----------- pkg/PORTING.md | 11 +++++++++++ pkg/USING | 5 ----- pkg/USING.md | 5 +++++ 4 files changed, 16 insertions(+), 16 deletions(-) delete mode 100644 pkg/PORTING create mode 100644 pkg/PORTING.md delete mode 100644 pkg/USING create mode 100644 pkg/USING.md diff --git a/pkg/PORTING b/pkg/PORTING deleted file mode 100644 index 2c4003a79..000000000 --- a/pkg/PORTING +++ /dev/null @@ -1,11 +0,0 @@ -This directory provides some porting information for libraries and programs to -use with RIOT (to build an external module). If you'd like to add a package to -RIOT you need to add a directory with the name of your package to this directory. -Your directory should contain at least two files: - - * patch.txt - Your patch of the upstream application of the package to make it - build with RIOT - * Makefile - A Makefile describing how to get the upstream application, apply - the patch and how to build the package as a RIOT module. - A rough template for several methods of acquiring a package - is provided in Makefile.git, Makefile.http, and Makefile.svn diff --git a/pkg/PORTING.md b/pkg/PORTING.md new file mode 100644 index 000000000..0bc0752f9 --- /dev/null +++ b/pkg/PORTING.md @@ -0,0 +1,11 @@ +This directory provides some porting information for libraries and programs to +use with RIOT (to build an external module). If you'd like to add a package to +RIOT you need to add a directory with the name of your package to this directory. +Your directory should contain at least two files: + + * **patch.txt**- Your patch of the upstream application of the package to make + it build with RIOT. + * **Makefile**- A Makefile describing how to get the upstream application, apply + the patch and how to build the package as a RIOT module. + A rough template for several methods of acquiring a package + is provided in Makefile.git, Makefile.http, and Makefile.svn diff --git a/pkg/USING b/pkg/USING deleted file mode 100644 index b5aa665e2..000000000 --- a/pkg/USING +++ /dev/null @@ -1,5 +0,0 @@ -Packages are included to your application as external modules. Thus you only have -to add the following line to your application (and update your INCLUDE path -accordingly): - -USEPKG += diff --git a/pkg/USING.md b/pkg/USING.md new file mode 100644 index 000000000..1de618b4c --- /dev/null +++ b/pkg/USING.md @@ -0,0 +1,5 @@ +Packages are included to your application as external modules. Thus you only +have to add the following line to your application (and update your INCLUDE path +accordingly): + + USEPKG +=