m

README.md

@@ -1,2 +1,21 @@
 # YOLOv8-TO
 Code for the article "From Density to Geometry: YOLOv8 Instance Segmentation for Reverse Engineering of Optimized Structures"
+## Overview
+Brief description of what the project does and the problem it solves. Include a link or reference to the original article that inspired or is associated with this implementation.
+
+##  Reference
+This code aims to reproduce the results presented in the research article:
+
+> Author(s). (Year). Title. *Journal*, Volume(Issue), Pages. DOI
+
+## Installation
+
+### Prerequisites
+This package comes with a fork of the ultralytics package in the yolov8-to directory. The fork is necessary to add the functionality of the design variables regression.
+
+### Installing
+
+```bash
+git clone https://github.com/COSIM-Lab/YOLOv8-TO.git
+cd YOLOv8-TO
+pip install -e .

yolov8-to/setup.py

@@ -19,7 +19,7 @@ def get_version():
 
 
 setup(
-    name='ultralytics-custom',  # name of pypi package
+    name='ultralyticscustom',  # name of pypi package
     version=get_version(),  # version of pypi package
     python_requires='>=3.8',
     license='AGPL-3.0',