Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document how to identify the versions of Noir compatible with versions of Barretenberg #7511

Closed
Savio-Sou opened this issue Jul 17, 2024 · 1 comment · Fixed by #9073
Closed

Document how to identify the versions of Noir compatible with versions of Barretenberg #7511

Savio-Sou opened this issue Jul 17, 2024 · 1 comment · Fixed by #9073
Labels
A-documentation Area: relates to documentation C-barretenberg Component: barretenberg cryptography library

Comments

@Savio-Sou
Copy link
Member

Different versions of Barretenberg are compatible with different versions of Noir.

Good to document how to identify that by e.g. flipping between GitHub release tags and checking a certain test file.
@Savio-Sou Savio-Sou added A-documentation Area: relates to documentation C-barretenberg Component: barretenberg cryptography library labels Jul 17, 2024
@github-project-automation github-project-automation bot moved this to Todo in A3 Jul 17, 2024
This was referenced Jul 19, 2024
Open
Merged
@Savio-Sou
Copy link
Member Author

Savio-Sou commented Jul 24, 2024 •
edited
Loading

Looks like Barretenberg doesn't actually pull versions of Noir and test against it? 🤔

As a workaround in the meantime, the information is somewhat available from flipping between Noir release tags and checking this file: https://github.com/noir-lang/noir/blob/master/scripts/install_bb.sh

E.g.

Savio-Sou added a commit that referenced this issue Jul 25, 2024
@Savio-Sou
chore(bb readme): Add installation instructions and TODOs (#7601)
1a97698 
# Summary

Updating bb's README:
- Add `bb` installation instructions
- Steps toward
#7511 and
#7600
@Savio-Sou Savio-Sou mentioned this issue Jul 25, 2024
Merged
5 tasks
AztecBot pushed a commit to AztecProtocol/barretenberg that referenced this issue Jul 26, 2024
@Savio-Sou @AztecBot
chore(bb readme): Add installation instructions and TODOs (#7601)
92043f7 
# Summary

Updating bb's README:
- Add `bb` installation instructions
- Steps toward
AztecProtocol/aztec-packages#7511 and
AztecProtocol/aztec-packages#7600
@Savio-Sou Savio-Sou mentioned this issue Oct 8, 2024
Merged
@github-project-automation github-project-automation bot moved this from Todo to Done in A3 Oct 10, 2024
AztecBot pushed a commit to AztecProtocol/barretenberg that referenced this issue Oct 11, 2024
@signorecello @Savio-Sou @AztecBot
chore(docs): rewriting bbup script, refactoring bb readme for clarity…
6aa8df7 
… (#9073)

## Description

Closes #8530

Closes AztecProtocol/aztec-packages#7511
AztecProtocol/aztec-packages#7525 as no longer
useful / relevant

This PR updates the Barretenberg README with more information about the
project, its installation, usage, and development.

It also refactors `bbup` with `commander` to match the rest of the
repository's CLI tooling.

## Changes

### bb readme
- Added a project banner and reorganized the README structure
- Expanded usage instructions for UltraHonk and MegaHonk

### bbup
- Refactored bbup installation script and related files
- Included detailed installation instructions in its README

## Testing

`bbup` won't change much so it is deployed manually on `npm`. You can
try it immediately with:

```bash
curl -L bbup.dev | bash
bbup
```

---------

Co-authored-by: Savio <[email protected]>
@iAmMichaelConnor iAmMichaelConnor removed this from A3 Oct 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-documentation Area: relates to documentation C-barretenberg Component: barretenberg cryptography library
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore(docs): rewriting bbup script, refactoring bb readme for clarity AztecProtocol/aztec-packages
1 participant
@Savio-Sou