diff --git a/README.md b/README.md index 2f54be0..785c5c1 100644 --- a/README.md +++ b/README.md @@ -11,18 +11,18 @@ - **Windows 10 и выше** (программа может работать и с ранними версиями, но не проверялась) - **Microsoft PowerStation 4.0** - Без него программа не заработает, т.к. в нем содержится нужный компилятор и линкер. В ином случае, программа предупредит вас об отсутствии нужных файлов и откажется сотрудничать. - **[Visual Studio Code](https://code.visualstudio.com/)** (или любой другой редактор с терминалом, либо ручками) -- Хотя бы небольшое количество прямых лапок +- Хотя бы небольшое количество прямых лапок и терпение ## Установка ### Способ для ленивых -Вы можете пропустить нюансы, установив ПО используя [последнюю версию установщика](https://git.dj-haski.ru/Dj_Haski/fortrun/...). +Вы можете пропустить нюансы, установив ПО используя [последнюю версию установщика (fortrun-setup.exe)](https://git.dj-haski.ru/Dj_Haski/fortrun/releases). После установки можете переходить сразу к **Использованию**. ### Способ для умных и прекрасных -Вам будет необходим Poetry ([установка](https://python-poetry.org/docs/)) и Python 3.10+ ([установка](https://www.python.org/downloads/)). +Вам будет необходим **Poetry** ([установка](https://python-poetry.org/docs/)) и **Python 3.10+** ([установка](https://www.python.org/downloads/)). Склонируйте репозиторий и перейдите в его папку: @@ -33,13 +33,13 @@ Cloning into 'fortrun'... $ cd fortrun/ ``` -Установите пакеты Poetry: +Установите пакеты **Poetry**: ```bash $ poetry install ``` -Запустите файл main.py с нужными параметрами: +Запустите файл **main.py** с нужными параметрами: ```bash $ poetry run main.py --help @@ -47,6 +47,12 @@ $ poetry run main.py --help $ poetry run main.py build FA.F90 VAP4.F90 bm_nlp-msdev.lib --run --friendly ``` +Для сборки установщика необходим [**Inno Setup**](https://jrsoftware.org/isinfo.php): + +```bash +$ /путь/до/innosetup/ISCC.exe .\setup.iss /Ffortrun-setup /Odist +``` + Бинго, вы прекрасны! Дальше по накатанной. ## Использование @@ -55,7 +61,7 @@ $ poetry run main.py build FA.F90 VAP4.F90 bm_nlp-msdev.lib --run --friendly Эта часть подразумевает, что вы установили ПО используя установщик. -1) Откройте Visual Studio Code +1) Запустите **Visual Studio Code** 2) Откройте папку, где будут тусоваться ваши исходные файлы: *Файл -> Открыть папку...* 3) Создайте терминал, если его нет внизу: *Терминал -> Новый терминал* 4) Используйте перечисленные команды ниже, чтобы достичь нужного результата. @@ -105,7 +111,7 @@ $ fortrun build FA.F90 VAP4.F90 bm_nlp-msdev.lib --friendly --output lab2.exe Помощь доступна через команду `fortrun --help`. - **fortrun version** - Просто выводит версию. И всё. -- **fortrun build** - Основная команда для компиляции и линковки файлов + библиотек. Флаги представлены ниже. +- **fortrun build** - Основная команда для компиляции и линковки файлов + библиотек, флаги представлены ниже (использовать так: `fortrun --флаг --флаг2 что-то --флаг`). - **--output [ФАЙЛ]** - Собрать всё в указанный файл. - **--run** - Запустить программу сразу после сборки. - **--friendly** - Работает только с `--run`. Заменять представления чисел Fortran на человекочитаемые. @@ -116,7 +122,7 @@ $ fortrun build FA.F90 VAP4.F90 bm_nlp-msdev.lib --friendly --output lab2.exe | **У меня пишутся какие-то "warning: ", это нормально?** -Да. Скорее всего, на это не стоит обращать внимания, т.к. в лабораторных встречались такие сценарии, которые никак не влияют на работу. +Да. Скорее всего, на это не стоит обращать внимания, так как в лабораторных встречались такие сценарии, которые никак не влияют на работу. | **Что значит ошибка "Looks like compilation or linking failed. Perhaps you forgot to add some libraries or some source files? Check your source code and try again."** @@ -126,12 +132,11 @@ $ fortrun build FA.F90 VAP4.F90 bm_nlp-msdev.lib --friendly --output lab2.exe Свяжитесь со мной по почте, указанной ниже. Не забудьте приложить скриншот проблемы. -| **Тут есть вирусы?** или **Антивирус [название] жалуется на твой файл!** - -Исходный код доступен прямо у вас перед глазами, если вы не доверяете готовым сборкам. К сожалению, в виду неизвестного происхождения файла (мы же с вами тут не Яндексы, чтоб все нас знали), файл может ложно помечаться как вредоностный. Исправление этой проблемы слишком дорогое (подпись исполняемых файлов для повышения репутации) для такого маленького проекта. - ## Контакты -В случае обнаружения бага или при наличии интересного предложения, свяжитесь со мной по почте: me@dj-haski.ru +В случае обнаружения бага или при наличии интересного предложения, свяжитесь со мной по почте: +``` +me@dj-haski.ru +``` Вопросы не касающиеся работы `fortrun` (этой проги), в 90% случаев остануться без ответа, ищите решение ошибок Fortran и лабораторных самостоятельно :) \ No newline at end of file