Dbhardwaj99 commented 1 year ago

Upgraded Readme

Related Issue

70

Description

This pull request aims to significantly improve the installation guide's readability and user experience. By providing clear instructions and examples, users can now effortlessly set up and utilise the "Resume Matcher" project. The changes also ensure that users correctly prepare their data and efficiently execute the application. Please review the modifications, and if deemed suitable, kindly consider merging this pull request into the main branch.

Type

[ ] Bug Fix
[ ] Feature Enhancement
[x] Documentation Update
[ ] Code Refactoring

Proposed Changes

Updated the installation guide in the README.md file to provide clearer and more concise instructions for setting up the "Resume Matcher" project.
Added step-by-step instructions for cloning the repository, creating a Python virtual environment, activating the virtual environment, and installing all dependencies using 'pip'.
Included instructions for preparing the data, specifically, how to place resumes and job descriptions in the correct folders and remove any existing contents.
Provided the commands to parse resumes to JSON and run the application using 'python' and 'streamlit'.

Screenshots

Checklist

[ ] The code compiles successfully without any errors or warnings
[ ] The changes have been tested and verified
[x] The documentation has been updated (if applicable)
[x] The changes follow the project's coding guidelines and best practices
[x] The commit messages are descriptive and follow the project's guidelines
[x] All tests (if applicable) pass successfully
[x] This pull request has been linked to the related issue (if applicable)

srbhr commented 1 year ago

Thanks @Dbhardwaj99 for this PR. I will check and let you know.

BTW are you on Discord? If not then do join here