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

Updates to setup/README #14

Open
tshaffe1 opened this issue Apr 16, 2019 · 0 comments
Open

Updates to setup/README #14

tshaffe1 opened this issue Apr 16, 2019 · 0 comments

Comments

@tshaffe1
Copy link
Collaborator

Going through the README, I had a few comments.

  • The project directory layout is a little confusing. The README mentions going to hashfs/caching, but it's not immediately clear where that is. The repo itself is called hashfs and has a caching directory, but there's also a hashfs directory with its own caching subdirectory. If you'd like to keep both hashfs/caching and hashfs/hashfs/caching, you should be sure the README is unambiguous.
  • CacheServer.py should use Python's argparse rather than messing with argv. Same advice for any argument parsing elsewhere.
  • The README should be organized with a first-time setup section with pip, virtualenv, etc. and a separate section for initializing the environment after that, in case a user wants to run servers in different terminals.
  • There should be some explanation of starting servers locally vs. pointing to another machine.
  • The contents of demo.sh should be merged directly into the README, with explanation as appropriate. Also, one of the paths in that script has changed.
  • The FUSE part should be expanded. The installation instructions should go in the setup section at the beginning, and there should be an example of running and configuring the FUSE module (and stopping it with fusermount).

It would also be a good idea to think about writing some automated tests and benchmarks (with instructions for running them in the README of course).

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

No branches or pull requests

1 participant