Skip to content

Commit d62f16e

Browse files
authored
docs: revise README for clarity and installation instructions
Updated README to clarify library's purpose and usage.
1 parent c873c92 commit d62f16e

1 file changed

Lines changed: 10 additions & 8 deletions

File tree

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,31 @@
33
[![Python](https://img.shields.io/badge/Made%20with-Python-blue.svg)](https://www.python.org/)
44
[![Last Commit](https://img.shields.io/github/last-commit/n1xsi/pycustomrand.svg)](https://github.com/n1xsi/pycustomrand/commits/main)
55

6-
> [!WARNING]
7-
> *Библиотека находится на стадии разработки*.
8-
>
9-
> Также PyCustomRand **не является** криптографически стойкой библиотекой и **не предназначена** для использования в системах безопасности ❗
10-
11-
**PyCustomRand** — это небольшая Python-библиотека для генерации **псевдослучайных чисел**, основанная на алгоритме, использующем системное время с наносекундной точностью (time-based).
6+
**PyCustomRand** — это Python-библиотека для генерации **псевдослучайных чисел**, основанная на алгоритме, использующем системное время с наносекундной точностью (time-based).
127
Проект также включает в себя кастомную реализацию математического (а не банковского) округления.
138

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

12+
> [!WARNING]
13+
> PyCustomRand **не является** криптографически стойкой библиотекой и **не предназначена** для использования в системах безопасности!
14+
> Используйте [secrets](https://docs.python.org/3/library/secrets.html#module-secrets) модуль.
15+
1716
## Основные возможности
18-
Все функции PyCustomRand основаны на [оригинальной](https://docs.python.org/3/library/random.html) Python-библиотеке:
17+
Практически все функции PyCustomRand основаны на [оригинальной](https://docs.python.org/3/library/random.html) Python-библиотеке для генерации псевдослучайных чисел:
1918
* Генерация случайных целых чисел заданной длины;
2019
* Генерация случайных чисел с плавающей точкой в диапазоне `[0, 1)`;
20+
* Генерация случайных чисел с плавающей точкой, распределёнными по математическим законам;
2121
* Выбор случайного элемента из списка;
22+
* Выборка случайных элементов из списка;
2223
* Перемешивание списка;
24+
* Вспомогательные функции - генерация случайного цвета, случайного uuid4, случайного bool;
2325
* А также: округление кастомной функцией `true_round`.
2426

2527
и т.д.
2628

2729
## Установка
28-
Поддерживается установка через `pip`:
30+
Библиотека поддерживает установку через `pip`:
2931
```bash
3032
pip install pycustomrand
3133
```

0 commit comments

Comments
 (0)