update README.md

egorcoders · web-flow · commit 15cc9ffd2c1d · 2022-08-17T23:22:33.000+05:00
diff --git a/README.md b/README.md
@@ -9,88 +9,112 @@
 
 Модуль представляет собой калькуляторы подсчёта финансов и калорий на основе записей пользователя.
 
-## Класс записей пользователя
+Класс записей пользователя
 
 ```python
 class Record
 ```
 
-### Свойства класса записей
+Свойства класса записей
 
-* amount - количество потребляемых калорий или потраченных денег;
-* comment - коментарии пользователя;
-* date - дата записи;
+- amount - количество потребляемых калорий или потраченных денег;
+- comment - коментарии пользователя;
+- date - дата записи;
 
-### Пример создания экземпляра класса
+Пример создания экземпляра класса
 
 ```python
 r1 = Record(amount=122, comment='Хороший шопинг', date='09.04.2019')
 ```
 
-## Базовый класс калькулятора
+Базовый класс калькулятора
 
 ```python
 class Calculator
 ```
 
-### Свойства класса калькулятора
+Свойства класса калькулятора
 
-* limit - максимально допустимое количество потребляемых калорий или потраченных денег;
-* records - словарь, содержащий все записи пользователя;
+- limit - максимально допустимое количество потребляемых калорий или потраченных денег;
+- records - словарь, содержащий все записи пользователя;
 
-### Методы класса калькулятора
+Методы класса калькулятора
 
-* `get_today_date()` - метод возвращает текущую дату;
-* `get_week_date()` - метод возвращает текущую неделю;
-* `add_record(record)` - метод принимает на вход новую запись `record` и добавляет её в словарь `records`;
-* `get_today_stats()` - метод возвращает сумму расходов на сегодня;
-* `get_week_stats()` - метод возвращает сумму расходов за неделю;
-* `get_today_limit()` - метод возвращает лимит расходов на сегодня;
+- `get_today_date()` - метод возвращает текущую дату;
+- `get_week_date()` - метод возвращает текущую неделю;
+- `add_record(record)` - метод принимает на вход новую запись `record` и добавляет её в словарь `records`;
+- `get_today_stats()` - метод возвращает сумму расходов на сегодня;
+- `get_week_stats()` - метод возвращает сумму расходов за неделю;
+- `get_today_limit()` - метод возвращает лимит расходов на сегодня;
 
-## Наследники класса калькулятора
+### Наследники класса калькулятора
 
-### Класс калькулятора денег
+Класс калькулятора денег
 
 ```python
 class CashCalculator
 ```
 
-### Свойства класса калькулятора денег
+Свойства класса
 
-* limit - максимально допустимое количество потраченных денег;
-* records - словарь, содержащий все записи пользователя;
+- limit - максимально допустимое количество потраченных денег;
+- records - словарь, содержащий все записи пользователя;
 
-### Константы класса калькулятора денег
+Константы класса
 
-* `USD_RATE` - курс доллара к рублю, USD/RUB;
-* `EURO_RATE` - курс евро к рублю, EUR/RUB;
+- `USD_RATE` - курс доллара к рублю, USD/RUB;
+- `EURO_RATE` - курс евро к рублю, EUR/RUB;
 
-### Методы класса калькулятора денег
+Методы класса
 
-* `get_today_cash_remained(currency)` - метод принимает на вход `currency` - ключ словаря `currencies` курсов валюты и возвращает сообщение о состоянии дневного баланса в указанной валюте, округляя значение типа float до 2 знаков после запятой:
-  * *«Указана неверная валюта. Повторите ввод.»*, если вводимая `currency` отсутствует в `currencies`;
-  * *«Денег нет, держись»*, если лимит достигнут;
-  * *«На сегодня осталось N руб/USD/Euro»*, если лимит `limit` не достигнут;
-  * *«Денег нет, держись: твой долг - N руб/USD/Euro»*, если лимит превышен;
+- `get_today_cash_remained(currency)` - метод принимает на вход `currency` - ключ словаря `currencies` курсов валюты и возвращает сообщение о состоянии дневного баланса в указанной валюте, округляя значение типа float до 2 знаков после запятой:
+  - _«Указана неверная валюта. Повторите ввод.»_, если вводимая `currency` отсутствует в `currencies`;
+  - _«Денег нет, держись»_, если лимит достигнут;
+  - _«На сегодня осталось N руб/USD/Euro»_, если лимит `limit` не достигнут;
+  - _«Денег нет, держись: твой долг - N руб/USD/Euro»_, если лимит превышен;
 
 ```python
 # базовая формула расчета
 лимит_расходов_на_сегодня / курс_валюты
 ```
 
-### Класс калькулятора калорий
+Класс калькулятора калорий
 
 ```python
 class CaloriesCalculator
 ```
 
-### Свойства класса калькулятора калорий
+Свойства класса
 
-* limit - максимально допустимое количество потребляемых калорий;
-* records - словарь, содержащий все записи пользователя;
+- limit - максимально допустимое количество потребляемых калорий;
+- records - словарь, содержащий все записи пользователя;
 
-### Методы класса калькулятора калорий
+Методы класса
 
-* `get_calories_remained()` - метод возвращает сообщение, в зависимости от значения `limit`:
-  * *«Сегодня можно съесть что-нибудь ещё, но с общей калорийностью не более N кКал»*, если лимит не достигнут;
-  * *«Хватит есть!*, если лимит превышен;
+- `get_calories_remained()` - метод возвращает сообщение, в зависимости от значения `limit`:
+  - _«Сегодня можно съесть что-нибудь ещё, но с общей калорийностью не более N кКал»_, если лимит не достигнут;
+  - _«Хватит есть!_, если лимит превышен;
+
+## Установка
+
+Клонировать репозиторий:
+
+```python
+git clone https://github.com/egorcoders/hw_python_oop.git
+```
+
+Перейти в папку с проектом:
+
+```python
+cd hw_python_oop/
+```
+
+Запустить проект локально:
+
+```python
+# для OS Lunix и MacOS
+python homework.py
+
+# для OS Windows
+python3 homework.py
+```
