Java - lesson 8 | HackIndia Skills

Java - lesson 8 | HackIndia Skills | HackIndia

Example

README that works

Use simple instructions. Mention the Java version you tested with. Show the exact command you expect someone to run.

This example assumes a Maven app that reads a JSON file from data/candidates.json.

# Recruiter CLI

A Java command-line app that reads candidate data and prints a shortlist.

## Requirements

- Java 17
- Maven 3.9 or later

## Build

mvn clean package

## Run

mvn exec:java -Dexec.mainClass="com.hackindia.recruiter.Main" -Dexec.args="data/candidates.json"

## Sample data

The sample file is included at:

data/candidates.json

## Expected output

Shortlisted candidates:
1. Asha Sharma - Java, SQL
2. Imran Khan - Java, Git

## Project structure

src/main/java - Java source code
data - sample input files
pom.xml - Maven build file

Tip

Test like a stranger

Before submitting, make a fresh clone in a different folder. Run only the README commands. If anything is missing, fix the repo and test again.

You can ask an AI tool to review your README, but check that it does not invent commands, plugins, folders, or features your project does not have.

git clone https://github.com/YOUR-USERNAME/recruiter-cli.git test-run
cd test-run
mvn clean package

Submit your public repo

Repo is the proof

What reviewers check

Final repo checklist

README that works

Avoid local paths

Test like a stranger

Submission flow

Do this now

Quick check