add nix setup for esp32 atomvm development #7

pxp9 · 2026-01-04T12:19:40Z

guide for setting up a development environment for AtomVM ESP32 in Nixos. It defines the toolchain is needed for compiling from source the AtomVM.

UncleGrumpy

This looks good, just a couple of details that need fixing and consideration.

tutorials.md

UncleGrumpy · 2026-01-04T16:57:58Z

tutorials.md

+                mbedtls_2
+                zlib
+                ninja
+                doxygen


doxygen should only be needed if you are building the AtomVM documentation.

i think this is fine, bc this flake provides the development environment to develop AtomVM on ESP32, including the docs

Then you will also need sphinx installed, doxygen alone is useless, you will need the rest of the requirements to build the docs:

rebar3

graphviz

Sphinx and other python deps found in AtomVM/doc/requirements.txt

Check out the docs/README.md for details:
https://github.com/atomvm/AtomVM/blob/main/doc/README.md

rebar3 is installed

beamMinimal27Packages.rebar3

this is the name is given in nix packages since this rebar3 is compiled with Erlang27

you can replace 27 for 28 and it will get the rebar3 compiled with erlang28

I spotted rebar3 right after I posted, was just about to edit that comment. ;-)

We are recommending OTP-28 for builds on main branch, and 27 for release-0.6 since that branch doesn't support OTP-28.

add dependencies to install the deps from the requirements in the pyt…

the guide explains you should change the versions for your specific builds, maybe we should add a note about this ??

We are recommending OTP-28 for builds on main branch, and 27 for release-0.6 since that branch doesn't support OTP-28.

tutorials.md

UncleGrumpy

This looks much better. Thank you for the contribution! I left another follow up comment about doxygen and the documentation.

UncleGrumpy · 2026-01-04T22:35:53Z

We will also want you to squash and signoff the commit before we merge.

UncleGrumpy · 2026-01-04T22:47:36Z

Unfortunately this now documentation site is not set up to be built and served locally anymore like our old one, so I cant test what the final rendered tutorial will look like, but otherwise spelling and grammar all looks fine to me.

pxp9 · 2026-01-04T22:57:18Z

Unfortunately this now documentation site is not set up to be built and served locally anymore like our old one, so I cant test what the final rendered tutorial will look like, but otherwise spelling and grammar all looks fine to me.

I managed to test it , but i did not commit the files

Gemfile

source "https://rubygems.org"

gem "github-pages", group: :jekyll_plugins
gem "webrick", "~> 1.7"  # Required for Ruby 3.0+

_config_dev.yml

host: "127.0.0.1"
port: 4000
url: "http://localhost:4000"

bundle exec jekyll serve --host 127.0.0.1

pxp9 · 2026-01-04T23:01:28Z

@UncleGrumpy , what do you mean sign off ? remove the GPG commit signing ??

UncleGrumpy · 2026-01-04T23:05:20Z

@UncleGrumpy , what do you mean sign off ? remove the GPG commit signing ??

No, keep that… use git -s as explained here. We do this for all commits to repos in the AtomVM organization:
https://github.com/apps/dco

Signed-off-by: Pepe Márquez Romero <pepe.marquezromero@protonmail.com>

…hon env from the esp-idf and add graphviz Signed-off-by: Pepe Márquez Romero <pepe.marquezromero@protonmail.com>

Signed-off-by: Pepe Márquez Romero <pepe.marquezromero@protonmail.com>

pxp9 · 2026-01-04T23:13:27Z

@UncleGrumpy , what do you mean sign off ? remove the GPG commit signing ??

No, keep that… use git -s as explained here. We do this for all commits to repos in the AtomVM organization: https://github.com/apps/dco

rebased with the option --signoff

commit messages should be fine now

UncleGrumpy · 2026-01-04T23:15:43Z

I managed to test it , but i did not commit the files

The Readme was just copied over from the old repo. It would be good to clean it up a little and update how to build locally for testing in a separate PR. I don’t think we necessarily want to merge the Gemfile and config yaml, that might disturb how it’s currently being served. Since they are short the content can be added to the Readme with instructions.

pxp9 · 2026-01-04T23:18:39Z

I managed to test it , but i did not commit the files

The Readme was just copied over from the old repo. It would be good to clean it up a little and update how to build locally for testing in a separate PR. I don’t think we necessarily want to merge the Gemfile and config yaml, that might disturb how it’s currently being served. Since they are short the content can be added to the Readme with instructions.

i can update the instructions in a separate PR

done in #8

UncleGrumpy

This looks great. Thank you again for the contribution. @bettio Will have to give this the final approval and do the merge.

If you squash or flatten your commits into the first one that would be great too. We don’t need our git history to include all the revisions during review, just have the meaningful commit messages with the actual changes being merged.

pxp9 · 2026-01-04T23:32:32Z

This looks great. Thank you again for the contribution. @bettio Will have to give this the final approval and do the merge.

If you squash or flatten your commits into the first one that would be great too. We don’t need our git history to include all the revisions during review, just have the meaningful commit messages with the actual changes being merged.

i will squash, it will take the PR name as a commit

UncleGrumpy · 2026-01-05T02:58:58Z

guide discussed in the PR

atomvm/exatomvm#65

@UncleGrumpy , could you check if do you find it useful, typos and so on ??

You probably want to change the PR description here to something more informative about the changes, so it can be read from the CLI and know what it's about without having to open a browser to look at the other PR to get a description. ;-)

pxp9 · 2026-01-05T09:56:02Z

@bettio , could you review please ?

UncleGrumpy · 2026-01-05T15:38:01Z

Thank you for updating the PR description. I did forget to mention we do have another little bit-picky detail that we use throughout the AtomVM organization repos, we like to capitalize the first word of the commit title (no end punctuation).

UncleGrumpy suggested changes Jan 4, 2026

View reviewed changes

pxp9 requested a review from UncleGrumpy January 4, 2026 17:30

UncleGrumpy suggested changes Jan 4, 2026

View reviewed changes

pxp9 added 4 commits January 5, 2026 00:11

add nix setup for esp32 atomvm development

6aacc8d

Signed-off-by: Pepe Márquez Romero <pepe.marquezromero@protonmail.com>

move the page under tutorials folder

1a0dff3

Signed-off-by: Pepe Márquez Romero <pepe.marquezromero@protonmail.com>

add dependencies to install the deps from the requirements in the pyt…

878eb54

…hon env from the esp-idf and add graphviz Signed-off-by: Pepe Márquez Romero <pepe.marquezromero@protonmail.com>

small fixes

103f036

Signed-off-by: Pepe Márquez Romero <pepe.marquezromero@protonmail.com>

pxp9 force-pushed the main branch from 803fd78 to 103f036 Compare January 4, 2026 23:12

pxp9 requested a review from UncleGrumpy January 4, 2026 23:29

UncleGrumpy approved these changes Jan 4, 2026

View reviewed changes

pxp9 requested a review from UncleGrumpy January 5, 2026 09:55

UncleGrumpy approved these changes Jan 5, 2026

View reviewed changes

bettio approved these changes Jan 5, 2026

View reviewed changes

bettio merged commit e19b03d into atomvm:main Jan 5, 2026

add nix setup for esp32 atomvm development #7

add nix setup for esp32 atomvm development #7

Uh oh!

Conversation

pxp9 commented Jan 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

UncleGrumpy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

UncleGrumpy left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

UncleGrumpy commented Jan 4, 2026

Uh oh!

UncleGrumpy commented Jan 4, 2026

Uh oh!

pxp9 commented Jan 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pxp9 commented Jan 4, 2026

Uh oh!

UncleGrumpy commented Jan 4, 2026

Uh oh!

pxp9 commented Jan 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

UncleGrumpy commented Jan 4, 2026

Uh oh!

pxp9 commented Jan 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

UncleGrumpy left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pxp9 commented Jan 4, 2026

Uh oh!

UncleGrumpy commented Jan 5, 2026

Uh oh!

pxp9 commented Jan 5, 2026

Uh oh!

UncleGrumpy commented Jan 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

pxp9 commented Jan 4, 2026 •

edited

Loading

UncleGrumpy left a comment •

edited

Loading

pxp9 commented Jan 4, 2026 •

edited

Loading

pxp9 commented Jan 4, 2026 •

edited

Loading

pxp9 commented Jan 4, 2026 •

edited

Loading

UncleGrumpy left a comment •

edited

Loading