Skip to content

Conversation

@galin-s
Copy link
Contributor

@galin-s galin-s commented Oct 23, 2024

created a table for packages

@zah
Copy link
Member

zah commented Oct 23, 2024

I think providing the list of packages near the top of the README will be better. We need something that will grab the attention of the readers and motivate them to read further.

An unsorted table also feels less exciting than grouping the packages in categories. Think of all the "Awesome X" repos. Most of them are organized in this way and for a good reason. Here is one example:

https://github.com/noir-lang/awesome-noir

@PetarKirov can help with determining the names of the categories.

@galin-s galin-s force-pushed the update-readme branch 2 times, most recently from f9baaa8 to 6f382e7 Compare October 23, 2024 15:20
@galin-s
Copy link
Contributor Author

galin-s commented Oct 23, 2024

@zah I've implemented the changes you have suggested, can you take a look?

@github-actions
Copy link
Contributor

Thanks for your Pull Request!

Below you will find a summary of the cachix status of each package, for each supported platform.

package x86_64-linux x86_64-darwin aarch64-darwin
avalanche-cli ✅ cached ✅ cached ✅ cached
blst ✅ cached ✅ cached ✅ cached
bnb-beacon-node ✅ cached ✅ cached ✅ cached
cardano ✅ cached ✅ cached 🚫 not supported
cdt ✅ cached 🚫 not supported 🚫 not supported
circom ✅ cached ✅ cached ✅ cached
circom_runtime ✅ cached ✅ cached ✅ cached
corepack-shims ✅ cached ✅ cached ✅ cached
cosmos-theta-testnet ✅ cached ✅ cached ✅ cached
emscripten ✅ cached ✅ cached ✅ cached
eos-vm ✅ cached 🚫 not supported 🚫 not supported
ffiasm ✅ cached ✅ cached 🚫 not supported
ffiasm-src ✅ cached ✅ cached 🚫 not supported
gaiad ✅ cached ✅ cached ✅ cached
go-opera ✅ cached ✅ cached ✅ cached
graphql ✅ cached ✅ cached 🚫 not supported
kurtosis ✅ cached 🚫 not supported 🚫 not supported
pistache ✅ cached 🚫 not supported 🚫 not supported
polkadot ✅ cached ✅ cached ✅ cached
polkadot-fast ✅ cached ✅ cached ✅ cached
py-ecc ✅ cached 🚫 not supported 🚫 not supported
rapidsnark ✅ cached ✅ cached 🚫 not supported
rapidsnark-server ✅ cached 🚫 not supported 🚫 not supported
wasmd ✅ cached 🚫 not supported 🚫 not supported
zqfield-bn254 ✅ cached ✅ cached 🚫 not supported

@zah zah merged commit b99c13f into main Oct 24, 2024
6 checks passed
@zah zah deleted the update-readme branch October 24, 2024 15:40
@zah
Copy link
Member

zah commented Oct 24, 2024

I've merged this because it's an improvement over the status quo, but I think few additional improvements can be made in follow-up PRs.

  1. You can add a table of contents at the top for the package categories.

  2. You can use headings and sub-headings instead of numbers and bullet lists (it will look prettier)

  3. Some of the packages are not in the right category (looks like we'll need help from the developers who are experts on these topics)

@zah zah mentioned this pull request Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants