📋 README: Инструкция по использованию алгоритмов

📚 Содержание

• 🔧 Сборка и запуск проекта с использованием скриптов
  • 📜 Что вам нужно сделать?
  • 🛠️ Сборка проекта с помощью build.sh
  • ▶️ Запуск проекта с помощью run.sh
• 📂 Где будут храниться данные?
• 👥 Взаимодействие с проектом

---

🚀 Проект: Алгоритмы и Графы

🔧 Сборка и запуск проекта с использованием скриптов

Для удобства сборки и запуска проекта, вы можете воспользоваться готовыми скриптами. Просто следуйте шагам ниже, и всё будет работать автоматически. 😊

---

📜 Что вам нужно сделать?

1. Клонировать репозиторий:

   Сначала склонируйте репозиторий, если вы этого ещё не сделали:

   git clone https://github.com/guglenskin/learn_algoritms.git
   cd путь_к_репозиторию

• Скачайте все зависимости:

  Убедитесь, что у вас установлены все необходимые инструменты, такие как CMake, Make, и Python.

• Запустите скрипты для сборки и запуска:

  У нас есть два скрипта, которые автоматизируют процесс сборки и запуска:

  • build.sh: Сборка проекта и генерация файлов.

  • run.sh: Запуск алгоритмов и визуализаторов.

    🛠️ Сборка проекта с помощью build.sh

Для сборки проекта с помощью CMake и Make, используйте скрипт build.sh. Он автоматически настроит проект и создаст исполнимые файлы.

1. Перейдите в корневую директорию проекта:

   cd /путь/к/проекту

2. Дайте разрешения на выполнение скрипта:

chmod +x build.sh

3. Запустите скрипт:

./build.sh

Скрипт создаст директории build/ и output/, а также сгенерирует все необходимые файлы для сборки и вывода. 🚀

▶️ Запуск проекта с помощью run.sh

После успешной сборки проекта, используйте скрипт run.sh для запуска всех алгоритмов и визуализаторов:

1. Дайте разрешения на выполнение скрипта:

   chmod +x run.sh`
   

2. Запустите скрипт:

    ./run.sh`

Этот скрипт выполнит следующие действия:

• Запустит алгоритм.

• Запустит Python-скрипты для визуализации графов.

• Все выходные данные (графы, изображения, модели) будут сохранены в папку output/. 🎨

---

📂 Где будут храниться данные?

Все выходные файлы, такие как данные графа и его визуализация, будут сохранены в папке output/:

• graph.dat — файл с данными графа (связи, веса).

• graph.png — изображение графа (2D).

• graph.obj — 3D модель графа для дальнейшего использования.

---

👥 Взаимодействие с проектом

Если у вас есть предложения по улучшению или исправлению ошибок, создайте issue или отправьте pull request.

Как создать issue:

1. Перейдите на страницу вашего репозитория.

2. Откройте вкладку Issues.

3. Нажмите на New issue и опишите вашу проблему или предложение.

---

🌟 Теперь у вас есть полное руководство по сборке и запуску проекта с использованием скриптов! Если возникнут вопросы, не стесняйтесь обращаться через issues. Удачи! 😊