Skip to content

improve build instructions#2037

Merged
ra3orblade merged 4 commits intoanyproto:developfrom
pompydev:build-process
Mar 20, 2026
Merged

improve build instructions#2037
ra3orblade merged 4 commits intoanyproto:developfrom
pompydev:build-process

Conversation

@pompydev
Copy link
Copy Markdown
Contributor

@pompydev pompydev commented Mar 7, 2026


  • I understand that contributing to this repository will require me to agree with the CLA

Description

This PR simplifies the build process for contributors and makes the instruction more clear.

Here's all the changes:

  • removed prerequisites section
    • the table of dependencies and commands to install them for each of the major linux distros was removed because libsecret and jq is only two of many dependencies contributors will have to hunt down regardless of whether we keep the list or not. Instead, I added a command to use the flake.nix file to create a shell with all the dependencies needed to build anytype-ts and anytype-heart. PROTOBUF_INCLUDE environment variable will be used in use PROTOBUF_INCLUDE environment variable if it is defined anytype-heart#3003
  • the instruction to build anytype-heart didn't make it clear that clone path was significant so I made it explicit

What type of PR is this?

  • 🍕 Feature
  • 🐛 Bug Fix
  • 📝 Documentation Update
  • 🎨 Style
  • 🧑‍💻 Code Refactor
  • 🔥 Performance Improvements
  • ✅ Test
  • 🤖 Build
  • 🔁 CI

Related Tickets & Documents

Mobile & Desktop Screenshots/Recordings

Added tests?

  • 👍 yes
  • 🙅 no, because they aren't needed
  • 🙋 no, because I need help

Added to documentation?

  • 📜 README.md
  • 📓 tech-docs
  • 🙅 no documentation needed

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 7, 2026

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@pompydev
Copy link
Copy Markdown
Contributor Author

pompydev commented Mar 8, 2026

I have read the CLA Document and I hereby sign the CLA

@ra3orblade
Copy link
Copy Markdown
Contributor

Hello, sorry I'm not answering because I was waiting middleware to merge your PR.

@ra3orblade ra3orblade requested a review from zarkone March 16, 2026 17:25
Comment thread flake.nix
Comment on lines +32 to 35
# anytype-heart
grpc-tools
protobuf

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey, thanks for the contribution! 🙏 we have a separate nix flake in anytype-heart which handles protobuf things. so all the new bits of flake.nix seem redundant. Or do you experience any problems with heart's flake?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not having issues per se but it saves people from having to switch nix shell or launch multiple terminals at the cost of two lines of code duplication. It also makes the instruction easier to follow.

@ra3orblade
Copy link
Copy Markdown
Contributor

Resolve conflicts please and I'll merge

@pompydev pompydev requested a review from ra3orblade March 20, 2026 10:40
@ra3orblade ra3orblade merged commit 2eac7b1 into anyproto:develop Mar 20, 2026
3 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Mar 20, 2026
@pompydev pompydev deleted the build-process branch March 20, 2026 15:17
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants