update readme

.gitignore

@@ -0,0 +1,6 @@
+*~
+*.pyc
+
+# Kopie zapasowe utworzone przez Visual Studio Code
+.vscode/
+*.vscode/

README.md

@@ -1,3 +1,19 @@
-# Fantastyczna wycena
+# fantastyczna_wycena Prototyp systemu informatycznego realizującego projekt dotyczący wyceny mieszkań
 
-Plik wykonywany w ramach projektu na przedmiocie "Systemy Informatyczne"
+## Podstawowe informacje 
+Celem projektu jest stworzenie aplikacji umożliwiającej użytkownikowi oszacowanie ceny mieszkania na podstawie
+najważniejszych zmiennych modelujących jego wartość takich jak liczba pokoi, metraż oraz rok budowy. W tym celu zaimplementowano
+model uczenia maszynowego opartego na regresji liniowej oraz stworzono przejrzysty interfejs użytkownika pozwalający
+na realizację usługi wyceny mieszkania. Praca została wykonana w zespole pięciu studentów: Alicja Lerczak, Adriam Szczeszek,
+Szymon Obst, Maciej Chmielarz, Łukasz Chrostowski.
+
+## Jak używać?
+- Pobierz aplikację z [repozytorium](https://git.wmi.amu.edu.pl/s478993/fantastyczna_wycena)
+- Wpisz w odpowiednich polach liczbę pokoi, metraż mieszkania oraz rok budowy na podstawie informacji o
+interesującym cię mieszkaniu.
+- Po uzupełnieniu wszystkich pól najedź myszką na pole „OBLICZ” znajdujące się w prawym dolnym rogu i kliknij na nie dwukrotnie.
+- Na ekranie pojawi się sugerowana cena mieszkania o interesujących Cię parametrach. 
+
+## Dodatkowe informacje
+Praca została wykonana w ramach zajęć z przedmiotu Systemy Informatyczne na kierunku Analiza i przetwarzanie
+danych Uniwersytetu im. Adama Mickiewicza w Poznaniu.