search

COXIT-CO / RecruitFlowAI

AI Driven Recruitment Assistant
MIT License
14 stars 2 forks source link

Make README the main documentation of the project. #3

Closed iramykytyn closed 1 year ago

iramykytyn commented 1 year ago

Readme should explain what issue the project solves, project's directory structure and overall architecture, how to install and how to run the project or different components of the project.

This should be clear enough so any new engineer will be able to run the project and start working on it as soon as possible

iramykytyn commented 1 year ago

The project should be renamed to represent the idea that it should optimize the whole recruitment pipeline, not only CV Scan part.