-
Notifications
You must be signed in to change notification settings - Fork 1
Updates to setup/README #14
Copy link
Copy link
Open
Description
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 calledhashfsand has acachingdirectory, but there's also ahashfsdirectory with its owncachingsubdirectory. If you'd like to keep bothhashfs/cachingandhashfs/hashfs/caching, you should be sure the README is unambiguous. CacheServer.pyshould use Python'sargparserather than messing withargv. 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.shshould 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).
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels