Skip to content

Modernize the README slightly#1543

Merged
RyanGlScott merged 4 commits intomasterfrom
T1542
Jul 6, 2023
Merged

Modernize the README slightly#1543
RyanGlScott merged 4 commits intomasterfrom
T1542

Conversation

@RyanGlScott
Copy link
Contributor

Mention Bretton Chen, Henry Blanchette, and Matthew Yacavone, all of whom have
made significant contributions. Also use Hazel Weakly's current name.
@RyanGlScott RyanGlScott requested a review from weaversa July 6, 2023 12:32
@RyanGlScott RyanGlScott temporarily deployed to github-pages July 6, 2023 12:32 — with GitHub Actions Inactive
@weaversa
Copy link
Collaborator

weaversa commented Jul 6, 2023

Woo!

I think there is potential for improvement in the Where to Look Next section. But that's all I see left.

@RyanGlScott
Copy link
Contributor Author

I think there is potential for improvement in the Where to Look Next section. But that's all I see left.

Are you referring to this sentence?

cryptol/README.md

Lines 181 to 182 in 57226ef

If you are familiar with version 1 of Cryptol, you should read the
`Version2Changes` document in the `docs` directory.

That is, would you like to see any accompanying document for changes between Cryptol 2 and 3?

@weaversa
Copy link
Collaborator

weaversa commented Jul 6, 2023

I think there is potential for improvement in the Where to Look Next section. But that's all I see left.

Are you referring to this sentence?

cryptol/README.md

Lines 181 to 182 in 57226ef

If you are familiar with version 1 of Cryptol, you should read the
`Version2Changes` document in the `docs` directory.

That is, would you like to see any accompanying document for changes between Cryptol 2 and 3?

That's the sentence. There was support for the move from 1 -> 2...it would be nice to have a Version3Changes, similar to the existing Version2Changes. Also, adjacent documentation also needs to be updated, for example, the syntax guide doesn't mention the new module system.

@yav
Copy link
Member

yav commented Jul 6, 2023

I think we may want to remove the "syntax guide". All the stuff in it should be in the reference manual---I used the syntax guide as the starting point for the reference manual.

It's easy to forget to update this. In addition, the version number is
specified elsewhere in the pyproject.toml file, so putting the version number
in the description in redundant.
@RyanGlScott RyanGlScott temporarily deployed to github-pages July 6, 2023 19:08 — with GitHub Actions Inactive
@RyanGlScott
Copy link
Contributor Author

Because these are larger changes (and I don't want to hold up the rest of this PR on them), I have opened separate issues to track the remaining documentation suggestions:

@RyanGlScott RyanGlScott merged commit 2919e6b into master Jul 6, 2023
@RyanGlScott RyanGlScott deleted the T1542 branch July 6, 2023 19:53
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.

Version 2 -> Version 3

3 participants