rota3015 7 месяцев назад
Родитель
Сommit
4877fcd4a5
1 измененных файлов с 10 добавлено и 1 удалено
  1. 10 1
      README.md

+ 10 - 1
README.md

@@ -1,3 +1,12 @@
 # CommunityRuleChatBot
 
-Community Rule Chatbot 
+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