Skip to content

Add Missing Dependency Instructions to README for Fresh Environment Setup #10

@lakkawardhananjay

Description

@lakkawardhananjay

Description:

While setting up LevelCache on a fresh system, I encountered a few missing dependencies and configuration steps that are essential for successfully building the project. The current README.md assumes that some libraries and tools are already installed, which may not be the case for first-time users or contributors.

This can lead to build failures or confusion during setup. To improve the developer experience and make the onboarding process smoother, I propose updating the README with clearer instructions.

Proposed Enhancements:

  • Add a Dependencies section listing the required packages:

    • libleveldb-dev
    • uthash.h
  • Provide installation instructions for LevelDB on common platforms (e.g., using apt on Ubuntu).

  • Include a setup.sh script for Linux users to install all dependencies in one step.(if you say ok, then only)

Proposed Fix:

I’d like to submit a PR that includes the above improvements. Please let me know if this enhancement would be welcomed. If so, I will proceed with creating the PR.

Benefits:

  • Simplifies setup for new developers and contributors
  • Reduces setup errors and missing dependency issues
  • Encourages contributions by improving the first-time experience

After looking at the benchmarks of the levelcache:-

Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions