forked from platformio/platformio-core
Renamed project's "libs" directory to "lib"
This commit is contained in:
10
README.rst
10
README.rst
@ -35,9 +35,9 @@ instruments.
|
||||
|
||||
**Platformio** is well suited for **embedded development**. It can:
|
||||
|
||||
* Automatic dependency analysis
|
||||
* Reliable detection of build changes
|
||||
* Compile framework or library sources to static libraries
|
||||
* Automatically analyse dependency
|
||||
* Reliably detect of build changes
|
||||
* Build framework or library source code to static library
|
||||
* Build *ELF* (executable and linkable firmware)
|
||||
* Convert *ELF* to *HEX* or *BIN* file
|
||||
* Extract *EEPROM* data
|
||||
@ -287,14 +287,14 @@ Initialize new platformio based project.
|
||||
# Example
|
||||
$ platformio init
|
||||
Project successfully initialized.
|
||||
Please put your source code to `src` directory, external libraries to `libs`
|
||||
Please put your source code to `src` directory, external libraries to `lib`
|
||||
and setup environments in `platformio.ini` file.
|
||||
Then process project with `platformio run` command.
|
||||
|
||||
After this command ``platformio`` will create:
|
||||
|
||||
* ``.pioenvs`` - a temporary working directory.
|
||||
* ``libs`` - a directory for project specific libraries. Platformio will
|
||||
* ``lib`` - a directory for project specific libraries. Platformio will
|
||||
compile their to static libraries and link to executable file
|
||||
* ``src`` - a source directory. Put code here.
|
||||
* ``platformio.ini`` - a configuration file for project
|
||||
|
@ -41,7 +41,11 @@ DefaultEnvironment(
|
||||
PLATFORMFW_DIR=join("$PLATFORM_DIR", "frameworks", "$FRAMEWORK"),
|
||||
PLATFORMTOOLS_DIR=join("$PLATFORM_DIR", "tools"),
|
||||
|
||||
BUILD_DIR=join("$PROJECT_DIR", ".pioenvs", "$PIOENV")
|
||||
BUILD_DIR=join("$PROJECT_DIR", ".pioenvs", "$PIOENV"),
|
||||
LIBSOURCE_DIRS=[
|
||||
join("$PROJECT_DIR", "lib"),
|
||||
join("$PLATFORMFW_DIR", "libraries"),
|
||||
]
|
||||
)
|
||||
|
||||
env = DefaultEnvironment()
|
||||
|
@ -16,7 +16,7 @@ def cli():
|
||||
|
||||
if isfile("platformio.ini") and isdir("src"):
|
||||
raise ProjectInitialized()
|
||||
for d in (".pioenvs", "libs", "src"):
|
||||
for d in (".pioenvs", "lib", "src"):
|
||||
if not isdir(d):
|
||||
makedirs(d)
|
||||
if not isfile("platformio.ini"):
|
||||
@ -24,7 +24,7 @@ def cli():
|
||||
"platformio.ini")
|
||||
secho("Project successfully initialized.\n"
|
||||
"Please put your source code to `src` directory, "
|
||||
"external libraries to `libs` and "
|
||||
"external libraries to `lib` and "
|
||||
"setup environments in `platformio.ini` file.\n"
|
||||
"Then process project with `platformio run` command.",
|
||||
fg="green")
|
||||
|
Reference in New Issue
Block a user