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.

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

Rework root README.md now that site is launched #74

Open
rufuspollock opened this issue Mar 18, 2022 · 4 comments
Open

Rework root README.md now that site is launched #74

rufuspollock opened this issue Mar 18, 2022 · 4 comments
Labels
good first issue Good for newcomers

Comments

@rufuspollock
Copy link
Member

README.md at root of repo is what people currently see arriving here. We should probably revise it given that a) we now have the main site b) it is now the contribute path for devs

Suggest:

  • Move current README content into e.g. notes as awesome-crypto-critique or similar (easiest)
    • Someday we can move all the library items into the library and then build the page off that but until then ... this is KISS
  • Revise README with brief intro to project and instructions for devs and others (and perhaps a pointer to old awesome-cryto-critique content for people who arrive at github repo looking for that - we still have quite a few links on twitter etc to it)
@rufuspollock rufuspollock added the good first issue Good for newcomers label Mar 18, 2022
@rufuspollock rufuspollock changed the title Rework README Rework root README.md now that site is launched Mar 18, 2022
@clairecharles
Copy link

Hey, @rufuspollock I would love to work on this if this hasn't been fixed

@rufuspollock
Copy link
Member Author

Great @claire-me please go ahead. Suggest starting by outlining briefly what you plan to do based on suggestions here and your ideas.

@clairecharles
Copy link

Hey, @rufuspolIock I will first move the README content to notes and create a new root README to explain the projects briefly. How's that?

@rufuspollock
Copy link
Member Author

rufuspollock commented Aug 15, 2022

@clairecharles that sounds good. i suggest starting with the second point and maybe drafting an outline of the new readme content in a public hackmd

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
Status: Backlog
Development

No branches or pull requests

2 participants