Skip to content

Commit

Permalink
Merge branch 'release/v1.2.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
ivankravets committed May 28, 2022
2 parents 559d883 + a4d468b commit e43b9ff
Show file tree
Hide file tree
Showing 12 changed files with 154 additions and 157 deletions.
35 changes: 25 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,33 @@
# Linux x86_64: development platform for [PlatformIO](http://platformio.org)
# Linux x86_64: development platform for [PlatformIO](https://platformio.org)

Linux x86_64 (64-bit) is a Unix-like and mostly POSIX-compliant computer operating system (OS) assembled under the model of free and open-source software development and distribution. Using host OS (Mac OS X or Linux 64-bit) you can build native application for Linux x86_64 platform.

* [Home](http://platformio.org/platforms/linux_x86_64) (home page in PlatformIO Platform Registry)
* [Documentation](http://docs.platformio.org/page/platforms/linux_x86_64.html) (advanced usage, packages, boards, frameworks, etc.)
* [Home](https://registry.platformio.org/platforms/platformio/linux_x86_64) (home page in the PlatformIO Registry)
* [Documentation](https://docs.platformio.org/page/platforms/linux_x86_64.html) (advanced usage, packages, boards, frameworks, etc.)

# Usage

1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html)
2. Install Linux x86_64 development platform:
```bash
# install the latest stable version
> platformio platform install linux_x86_64
1. [Install PlatformIO](https://platformio.org)
2. Create PlatformIO project and configure a platform option in [platformio.ini](https://docs.platformio.org/page/projectconf.html) file:

# install development version
> platformio platform install https://github.com/platformio/platform-linux_x86_64.git
## Stable version

```ini
[env:stable]
platform = linux_x86_64
board = ...
...
```

## Development version

```ini
[env:development]
platform = https://github.com/platformio/platform-linux_x86_64.git
board = ...
...
```

# Configuration

Please navigate to [documentation](https://docs.platformio.org/page/platforms/linux_x86_64.html).
3 changes: 1 addition & 2 deletions examples/hello-world/.gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
.pioenvs
.clang_complete
.gcc-flags.json
.piolibdeps
65 changes: 0 additions & 65 deletions examples/hello-world/.travis.yml

This file was deleted.

21 changes: 21 additions & 0 deletions examples/hello-world/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
How to build PlatformIO based project
=====================================

1. [Install PlatformIO Core](https://docs.platformio.org/page/core.html)
2. Download [development platform with examples](https://github.com/platformio/platform-linux_x86_64/archive/develop.zip)
3. Extract ZIP archive
4. Run these commands:

```shell
# Change directory to example
$ cd platform-linux_x86_64/examples/hello-world

# Build project
$ pio run

# Run program
> .pioenvs/native/program

# Clean build files
$ pio run --target clean
```
32 changes: 0 additions & 32 deletions examples/hello-world/README.rst

This file was deleted.

39 changes: 39 additions & 0 deletions examples/hello-world/include/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@

This directory is intended for project header files.

A header file is a file containing C declarations and macro definitions
to be shared between several project source files. You request the use of a
header file in your project source file (C, C++, etc) located in `src` folder
by including it, with the C preprocessing directive `#include'.

```src/main.c

#include "header.h"

int main (void)
{
...
}
```

Including a header file produces the same results as copying the header file
into each source file that needs it. Such copying would be time-consuming
and error-prone. With a header file, the related declarations appear
in only one place. If they need to be changed, they can be changed in one
place, and programs that include the header file will automatically use the
new version when next recompiled. The header file eliminates the labor of
finding and changing all the copies as well as the risk that a failure to
find one copy will result in inconsistencies within a program.

In C, the usual convention is to give header files names that end with `.h'.
It is most portable to use only letters, digits, dashes, and underscores in
header file names, and at most one dot.

Read more about using header files in official GCC documentation:

* Include Syntax
* Include Operation
* Once-Only Headers
* Computed Includes

https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html
46 changes: 46 additions & 0 deletions examples/hello-world/lib/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@

This directory is intended for project specific (private) libraries.
PlatformIO will compile them to static libraries and link into executable file.

The source code of each library should be placed in a an own separate directory
("lib/your_library_name/[here are source files]").

For example, see a structure of the following two libraries `Foo` and `Bar`:

|--lib
| |
| |--Bar
| | |--docs
| | |--examples
| | |--src
| | |- Bar.c
| | |- Bar.h
| | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
| |
| |--Foo
| | |- Foo.c
| | |- Foo.h
| |
| |- README --> THIS FILE
|
|- platformio.ini
|--src
|- main.c

and a contents of `src/main.c`:
```
#include <Foo.h>
#include <Bar.h>

int main (void)
{
...
}

```

PlatformIO Library Dependency Finder will find automatically dependent
libraries scanning project source files.

More information about PlatformIO Library Dependency Finder
- https://docs.platformio.org/page/librarymanager/ldf.html
38 changes: 0 additions & 38 deletions examples/hello-world/lib/readme.txt

This file was deleted.

2 changes: 1 addition & 1 deletion examples/hello-world/platformio.ini
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
; Library options: dependencies, extra library storages
;
; Please visit documentation for the other options and examples
; http://docs.platformio.org/page/projectconf.html
; https://docs.platformio.org/page/projectconf.html

[env:linux_x86_64]
platform = linux_x86_64
11 changes: 11 additions & 0 deletions examples/hello-world/test/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

This directory is intended for PIO Unit Testing and project tests.

Unit Testing is a software testing method by which individual units of
source code, sets of one or more MCU program modules together with associated
control data, usage procedures, and operating procedures, are tested to
determine whether they are fit for use. Unit testing finds problems early
in the development cycle.

More information about PIO Unit Testing:
- https://docs.platformio.org/page/plus/unit-testing.html
17 changes: 9 additions & 8 deletions platform.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,25 @@
"name": "linux_x86_64",
"title": "Linux x86_64",
"description": "Linux x86_64 (64-bit) is a Unix-like and mostly POSIX-compliant computer operating system (OS) assembled under the model of free and open-source software development and distribution. Using host OS (Mac OS X or Linux 64-bit) you can build native application for Linux x86_64 platform.",
"url": "http://platformio.org/platforms/linux_x86_64",
"homepage": "http://platformio.org/platforms/linux_x86_64",
"homepage": "https://registry.platformio.org/platforms/platformio/linux_x86_64",
"license": "Apache-2.0",
"keywords": [
"dev-platform",
"Linux",
"x86_64"
],
"engines": {
"platformio": "^3.0.0"
"platformio": "^6"
},
"repository": {
"type": "git",
"url": "https://github.com/platformio/platform-linux_x86_64.git"
},
"version": "1.1.2",
"packageRepositories": [
"https://dl.bintray.com/platformio/dl-packages/manifest.json",
"http://dl.platformio.org/packages/manifest.json"
],
"version": "1.2.0",
"packages": {
"toolchain-gcclinux64": {
"type": "toolchain",
"owner": "platformio",
"version": "~1.40801.0"
}
}
Expand Down
2 changes: 1 addition & 1 deletion platform.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.

from platformio.managers.platform import PlatformBase
from platformio.public import PlatformBase
from platformio.util import get_systype


Expand Down

0 comments on commit e43b9ff

Please sign in to comment.