From 8e42c4ae31a569b429b0c1c5d9511115f5c3d2b1 Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Fri, 21 Aug 2015 23:56:22 +0300 Subject: [PATCH] Explain that `lib` dir is suitable for private libraries // Issue #273 --- docs/quickstart.rst | 2 +- docs/userguide/cmd_init.rst | 10 +++++----- platformio/commands/init.py | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/quickstart.rst b/docs/quickstart.rst index a2336d16..a4d5864a 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -29,7 +29,7 @@ Quickstart The next files/directories will be created in *** platformio.ini - Project Configuration File. |-> PLEASE EDIT ME <-| src - Put your source code here - lib - Put here project specific or 3-rd party libraries + lib - Put here project specific (private) libraries Do you want to continue? [y/N]: y Project has been successfully initialized! Useful commands: diff --git a/docs/userguide/cmd_init.rst b/docs/userguide/cmd_init.rst index 02e140de..33ee76ec 100644 --- a/docs/userguide/cmd_init.rst +++ b/docs/userguide/cmd_init.rst @@ -23,8 +23,8 @@ This command will create: * :ref:`projectconf` * ``src`` - a source directory. Put your source code here -* ``lib`` - a directory for the project specific libraries. PlatformIO will - compile them to static libraries and link to executable file +* ``lib`` - a directory for the project specific (private) libraries. + PlatformIO will compile them to static libraries and link to executable file Options ------- @@ -91,7 +91,7 @@ Examples The next files/directories will be created in *** platformio.ini - Project Configuration File. |-> PLEASE EDIT ME <-| src - Put your source code here - lib - Put here project specific or 3-rd party libraries + lib - Put here project specific (private) libraries Do you want to continue? [y/N]: y Project has been successfully initialized! Useful commands: @@ -109,7 +109,7 @@ Examples The next files/directories will be created in *** platformio.ini - Project Configuration File. |-> PLEASE EDIT ME <-| src - Put your source code here - lib - Put here project specific or 3-rd party libraries + lib - Put here project specific (private) libraries Do you want to continue? [y/N]: y Project has been successfully initialized! Useful commands: @@ -133,7 +133,7 @@ Examples The next files/directories will be created in *** platformio.ini - Project Configuration File. |-> PLEASE EDIT ME <-| src - Put your source code here - lib - Put here project specific or 3-rd party libraries + lib - Put here project specific (private) libraries Do you want to continue? [y/N]: y Project has been successfully initialized! Useful commands: diff --git a/platformio/commands/init.py b/platformio/commands/init.py index 3346b635..270eb2ea 100644 --- a/platformio/commands/init.py +++ b/platformio/commands/init.py @@ -62,7 +62,7 @@ def cli(project_dir, board, ide, disable_auto_uploading, env_prefix): click.style("platformio.ini", fg="cyan")) click.echo("%s - Put your source code here" % click.style("src", fg="cyan")) - click.echo("%s - Put here project specific or 3-rd party libraries" % + click.echo("%s - Put here project specific (private) libraries" % click.style("lib", fg="cyan")) if (app.get_setting("enable_prompts") and