diff --git a/README.md b/README.md index be967c0..7e4c89d 100644 --- a/README.md +++ b/README.md @@ -1 +1,38 @@ -# ku-polls \ No newline at end of file +# ku-polls + +## Online Polls + +**KU Poll** is a web application to do online polls. + +## How to install and ku-polls + +Window + +```bash +git clone https://github.com/Sosokker/ku-polls +cd ku-polls +pip install -r requirements.txt +python manage.py migrate +python manage.py runserver +``` +Then connect to `127.0.0.1:8000/` + +**Optional** + +You can create virtual environment by using this command before install requirements.txt +```bash +python -m virtualenv .venv +``` +or +```bash +python -m venv .venv +``` +then +```bash +.venv\Scripts\activate +``` + +## Document + +- [Wiki Page](https://github.com/Sosokker/ku-polls/wiki) +- [Project Page](https://github.com/users/Sosokker/projects/2) \ No newline at end of file