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

README changes / code re-org for clarity #130

Open
wwoods opened this issue Dec 1, 2020 · 0 comments
Open

README changes / code re-org for clarity #130

wwoods opened this issue Dec 1, 2020 · 0 comments
Assignees
Labels
Docs Documentation Low-Hanging Fruit Good first task to meet the code TODO A task to be done that isn't a bug or feature

Comments

@wwoods
Copy link

wwoods commented Dec 1, 2020

A newcomer to this repo might find it difficult to locate the various parts of argo, or understand the point of the whole package. I've recently learned that argo is in fact a subprotocol of JSON RPC with reference implementations for the server and client, in Haskell and Python, respectively.

To help with this, the current argo folder could be renamed to argo-server-hs, and the python folder could be renamed to argo-client-py. This would be easy to spot, and would pair well with a PyPI module named argo_client. Generally, a Python module should share the same name as its source directly, though in this case the -py would be helpful since the argo repo is really a repository of reference implementations.

The README also needs an update to explicitly state that argo is a subprotocol for JSON-RPC, and that the repository contains reference implementations of the server in Haskell and the client in Python.

This is separate from, but complementary to, excising all of the SAW/Cryptol-specific code from this repository.

@pnwamk pnwamk added Docs Documentation Low-Hanging Fruit Good first task to meet the code TODO A task to be done that isn't a bug or feature labels Dec 1, 2020
@pnwamk pnwamk self-assigned this Dec 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Documentation Low-Hanging Fruit Good first task to meet the code TODO A task to be done that isn't a bug or feature
Projects
None yet
Development

No branches or pull requests

2 participants