diff --git a/README.md b/README.md index 835aa9f..183abc8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,12 @@ # CommunityRuleChatBot -Community Rule Chatbot \ No newline at end of file +Community Rule Chatbot + +### How to run +* If you are running for first time, you need to install python virtual enviroment +* Activate the python environment using source `source myenv/bin/activate` +* Install dependencies using `pip install -r requirements.txt` +* To run the backend run `python3 run.py` + +### Future Work +The code is written in a such a way that in future you can write any kind of logic like ML or Neural Networks and you just have to change the backend and API is exposed for frontend \ No newline at end of file