Packages

nerves_bootstrap

1.0.0-rc.3
1.16.0 1.15.3 1.15.2 1.15.1 1.15.0 1.14.5 1.14.4 1.14.3 1.14.2 1.14.0 1.13.1 1.13.0 1.12.2 1.12.1 1.12.0 1.11.5 1.11.4 1.11.3 1.11.2 1.11.1 1.11.0 1.10.6 1.10.5 1.10.4 1.10.3 1.10.2 1.10.1 1.10.0 1.9.0 1.8.1 1.8.0 1.7.1 1.7.0 1.6.3 1.6.2 1.6.1 1.6.0 1.5.3 1.5.2 1.5.1 1.5.0 1.4.3 1.4.2 1.4.1 1.4.0 1.3.4 1.3.3 1.3.2 1.3.1 1.3.0 1.2.1 1.2.0 1.1.0 1.0.1 1.0.0 1.0.0-rc.4 1.0.0-rc.3 1.0.0-rc.2 1.0.0-rc.1 1.0.0-rc.0 0.8.2 0.8.1 0.8.0 0.7.1 0.7.0 0.6.4 0.6.3

Nerves mix integration bootstrap and new project generator

HexDocs

Current section

Files

Jump to
Readme
67 Versions
0 Dependencies
0 Dependants
Files
Activity
nerves_bootstrap templates new README.md
Raw

templates/new/README.md 

# <%= app_module %>



**TODO: Add description**



## Targets



Nerves applications produce images for hardware targets based on the

`MIX_TARGET` environment variable. If `MIX_TARGET` is unset, `mix` builds an

image that runs on the host (e.g., your laptop). This is useful for executing

logic tests, running utilities, and debugging. Other targets are represented by

a short name like `rpi3` that maps to a Nerves system image for that platform.

All of this logic is in the generated `mix.exs` and may be customized. For more

information about targets see:



https://hexdocs.pm/nerves/targets.html#content



## Getting Started



To start your Nerves app:

  * `export MIX_TARGET=my_target` or prefix every command with

    `MIX_TARGET=my_target`. For example, `MIX_TARGET=rpi3`

  * Install dependencies with `mix deps.get`

  * Create firmware with `mix firmware`

  * Burn to an SD card with `mix firmware.burn`



## Learn more



  * Official docs: https://hexdocs.pm/nerves/getting-started.html

  * Official website: http://www.nerves-project.org/

  * Discussion Slack elixir-lang #nerves ([Invite](https://elixir-slackin.herokuapp.com/))

  * Source: https://github.com/nerves-project/nerves