diff --git a/README.md b/README.md index 89cc645..2efad47 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,20 @@ -##Systemy Informatyczne -###Grupa B +## Systemy Informatyczne
+### Grupa B
-Celem projektu jest zaznajomienie się studentów z systemem kontroli wersji Git. +Celem projektu jest zaznajomienie się studentów z systemem kontroli wersji Git.
-###W ramach projektu przeprowadzone zostaną następujące czynności: +### W ramach projektu przeprowadzone zostaną następujące czynności:
1. Utworzenie repozytorium 2. Sklonowanie repozytorium przez wszystkich członków grupy. 3. Modyfikacja plików będących efektem pracy podczas poprzednich laboratoriów zgodnie z komentarzami prowadzących. 4. Na gałęzi master znajdują się pliki README, gitignore oraz kody źródłowe, natomiast rysunki znajdują się na gałęzi with-pictures. -###Instalacja i uruchamianie aplikacji: +### Instalacja i uruchamianie aplikacji:
+1. W pierwszej kolejności należy skolonować repozytorium +2. Następnie należy wykonać polecenie: pip install -r requirements.txt +3. W celu skorzystania z kalkulatora mieszkań należy uruchomić plik interface.py. - -###Podręcznik użytkownika:
+### Podręcznik użytkownika:
- Interfejs programu zawiera dwa pola do wprowadzania parametrów. Użytkownik wpisuje metraż mieszkania oraz piętro, na którym znajduje się mieszkanie. - Oba pola nie mogą być puste, a wpisywane wartości muszą być typu numerycznego. Wprowadzone wartości metrażu powinny zawierać się w przedziale od 0 do 100 000 metrów kwadratowych, a liczba pięter powinna zawierać sie w przedziale od 0 do 100. Jeśli wprowadzone dane nie zawierją się w tych przedziałach, to wyświetlony zostaje komunikat: "Please provid numbers between 0 to 100 for floors and 0 to 100 000 for metric area.". Jeśli któreś z pól pozostanie puste to pojawi się komunikat: "Please provide valid data". - Po prawidłowym uzupełnieniu pól można uruchomić kalkulator za pomocą przycisku "start". Program poprosi o potwierdzenie startu. Wynikiem działania programu jest prognozowana cena mieszkania, wyliczona na podstawie działania modelu regresji liniowej. \ No newline at end of file