Skip to content

Commit 9e401a4

Browse files
authored
docs: refactor of the installation section
1 parent e5f639c commit 9e401a4

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

README.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@
88

99
</div>
1010

11-
**PyCustomRand** — это Python-библиотека для генерации **псевдослучайных чисел**, основанная на алгоритме, использующем системное время с наносекундной точностью и линейный конгруэнтный метод.
11+
**PyCustomRand** — это Python-библиотека для генерации **псевдослучайных чисел**, основанная на алгоритме, использующем системное время с наносекундной точностью.
1212

13-
Этот авторский проект создан для изучения алгоритмов и альтернативных подходов к генерации случайных чисел и их округлении.
13+
Данный авторский проект создан для изучения алгоритмов и альтернативных подходов к генерации случайных чисел и их округлении.
1414
Меня не устраивало, что модуль `random` в Python генерирует недостаточно случайные числа ( *особенно при нескольких последовательных генерациях* ), а встроенный в Python модуль `round` довольно "грубо" округляет числа ( *`round(1.5)` = 2 и в то же время `round(2.5)` = 2* ), поэтому я решил написать *свою* библиотеку для генерации псевдослучайных чисел — более простую и с наибольшей энтропией.
1515

1616
> [!WARNING]
1717
> PyCustomRand **не является** криптографически стойкой библиотекой и **не предназначена** для использования в системах безопасности!
1818
> Используйте [secrets](https://docs.python.org/3/library/secrets.html#module-secrets) модуль.
1919
2020
## ✨ Основные возможности библиотеки
21-
* 🕰 Собственная реализация генератора псевдослучайных чисел: уникальный алгоритм, использующий системное время с точностью до наносекунд + линейный конгруэнтный метод.
21+
* 🕰 Собственная реализация генератора псевдослучайных чисел (PRNG): уникальный алгоритм, использующий системное время с точностью до наносекунд + линейный конгруэнтный метод (LCG).
2222
* 🎯 Наличие честного округления (`true_round`): функция округляет числа привычным математическим способом (0.5 всегда вверх по модулю), а также исправляет погрешности плавающей точки (например, "проблему 2.675").
2323
* 🔢 Имеется полный набор функций для работы с числами и последовательностями, основанных на [оригинальной](https://docs.python.org/3/library/random.html) Python-библиотеке:
2424
* Генерация целых чисел (`random_integer`, `randrange`, `gen_random_number`).
@@ -29,16 +29,25 @@
2929
* 📦 Zero-Dependency: библиотека написана на чистом Python и не требует установки сторонних зависимостей. Работает везде, где есть Python.
3030
* ✅ Надёжность: код покрыт unit-тестами, а встроенный модуль диагностики (`check_distribution`) позволяет в любой момент проверить равномерность распределения генератора.
3131

32-
## Установка
33-
Библиотека поддерживает установку через `pip`:
32+
## 📦 Установка
33+
Установка библиотеки происходит через стандартный менеджер пакетов для Python:
3434
```bash
3535
pip install pycustomrand
3636
```
3737

38-
Альтернативный (старый) способ (клонирование репозитория):
39-
```bash
40-
git clone https://github.com/n1xsi/PyCustomRand.git
41-
```
38+
<details>
39+
<summary>Альтернативные способы</summary>
40+
41+
<br>
42+
43+
* Клонирование репозитория:
44+
```bash
45+
git clone https://github.com/n1xsi/PyCustomRand.git
46+
```
47+
48+
* Скачивание пакета напрямую в разделе *Releases*:
49+
https://github.com/n1xsi/PyCustomRand/releases
50+
</details>
4251

4352
## Пример использования
4453
```python

0 commit comments

Comments
 (0)