drowsycoder
commented
1 year ago Ридми долен быть более чётким планом действий. Первое, второе, третье и т.д. Без художественных оборотов. Раздел "Клонирование репозитория" - такая-то команда. "Создание виртуального окружения" - такая-то и т.п. Привести варианты для разных ОС: сейчас не упоминается вариация написания через python3 для *nix, а ещё у windows- и linux-систем разные слеши, что проигнорировано ;) Тем более, что мы же не уточняем, что там: cmd, gitbash, wsl и т.д.
Затем вернитесь в корневую папку проекта
Да вроде цель на текущем этапе достигнута, лишнее телодвижение
Как? Где? Мы до этого уже как-то склонировали проект (
git clone ...) и перешли в какую-то директорию (cd ...)? А какой командой создать и активировать венв?А где она? Нам опять надо перейти в какую-то директорию какой-то командой?
Очевидно? Не думаю
Нам надо (не забывая переходить в соответствующие папки):
И желательно это указывать не просто блоком команд, а пояснять, что каждая делает. Здесь минимализм не лучшее решение
Раздел с руководством в ридми нужен для того, чтобы за руку провести человека от захода в репо до работы с проектом Иногда полезно встать на его место и самостоятельно повторить указанные шаги (могут найтись недоработки)
Кроме того, для винды и линуксов всяких так-то команды разные Где-то, например, нужно будет
source venv/bin/activate, а где-то.\venv\Scripts\activateВсякиеpython/python3опять же. Ну илиpip/pip3(ладно, здесь ещё можно на soft links скидку сделать) (Можно даже разницу в командах для каждого пункта табличкой оформить, почему нет)