Skip to content

Update README.md #177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 27, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 62 additions & 64 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
<br>
<a href="https://www.ultralytics.com/" target="_blank"><img src="https://raw.githubusercontent.com/ultralytics/assets/main/logo/Ultralytics_Logotype_Original.svg" width="320" alt="Ultralytics logo"></a>

# πŸ“š Ultralytics Docs

Ultralytics Docs are the gateway to understanding and utilizing our cutting-edge machine learning tools. These documents are deployed to [https://docs.ultralytics.com](https://docs.ultralytics.com/) for your convenience.
Welcome to Ultralytics Docs, your comprehensive resource for understanding and utilizing our state-of-the-art [machine learning](https://www.ultralytics.com/glossary/machine-learning-ml) tools and models, including [Ultralytics YOLO](https://docs.ultralytics.com/models/yolov8/). These documents are actively maintained and deployed to [https://docs.ultralytics.com](https://docs.ultralytics.com/) for easy access.

[![pages-build-deployment](https://github.com/ultralytics/docs/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/ultralytics/docs/actions/workflows/pages/pages-build-deployment)
[![Check Broken links](https://github.com/ultralytics/docs/actions/workflows/links.yml/badge.svg)](https://github.com/ultralytics/docs/actions/workflows/links.yml)
Expand All @@ -18,116 +17,115 @@ Ultralytics Docs are the gateway to understanding and utilizing our cutting-edge
[![Downloads](https://static.pepy.tech/badge/ultralytics)](https://www.pepy.tech/projects/ultralytics)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ultralytics?logo=python&logoColor=gold)](https://pypi.org/project/ultralytics/)

To install the ultralytics package in developer mode, ensure you have Git and Python 3 installed on your system. Then, follow these steps:
To install the `ultralytics` package in developer mode, which allows you to modify the source code directly, ensure you have [Git](https://git-scm.com/) and [Python](https://www.python.org/) 3.9 or later installed on your system. Then, follow these steps:

1. Clone the ultralytics repository to your local machine using Git:
1. Clone the `ultralytics` repository to your local machine using Git:

```bash
git clone https://github.com/ultralytics/ultralytics.git
```
```bash
git clone https://github.com/ultralytics/ultralytics.git
```

2. Navigate to the cloned repository's root directory:
2. Navigate to the cloned repository's root directory:

```bash
cd ultralytics
```
```bash
cd ultralytics
```

3. Install the package in developer mode using pip (or pip3 for Python 3):
3. Install the package in editable mode (`-e`) along with its development dependencies (`[dev]`) using [pip](https://pip.pypa.io/en/stable/):

```bash
pip install -e '.[dev]'
```
```bash
pip install -e '.[dev]'
```

- This command installs the ultralytics package along with all development dependencies, allowing you to modify the package code and have the changes immediately reflected in your Python environment.
This command installs the `ultralytics` package such that changes to the source code are immediately reflected in your environment, ideal for development.

## πŸš€ Building and Serving Locally

The `mkdocs serve` command builds and serves a local version of your MkDocs documentation, ideal for development and testing:
The `mkdocs serve` command builds and serves a local version of your [MkDocs](https://www.mkdocs.org/) documentation. This is highly useful during development and testing to preview changes.

```bash
mkdocs serve
```

- #### Command Breakdown:

- `mkdocs` is the main MkDocs command-line interface.
- `serve` is the subcommand to build and locally serve your documentation.

- 🧐 Note:

- Grasp changes to the docs in real-time as `mkdocs serve` supports live reloading.
- To stop the local server, press `CTRL+C`.
- **Command Breakdown:**
- `mkdocs`: The main MkDocs command-line interface tool.
- `serve`: The subcommand used to build and locally serve your documentation site.
- **Note:**
- `mkdocs serve` includes live reloading, automatically updating the preview in your browser as you save changes to the documentation files.
- To stop the local server, simply press `CTRL+C` in your terminal.

## 🌍 Building and Serving Multi-Language

Supporting multi-language documentation? Follow these steps:
If your documentation supports multiple languages, follow these steps to build and preview all versions:

1. Stage all new language \*.md files with Git:
1. Stage all new or modified language Markdown (`.md`) files using Git:

```bash
git add docs/**/*.md -f
```
```bash
git add docs/**/*.md -f
```

2. Build all languages to the `/site` folder, ensuring relevant root-level files are present:
2. Build all language versions into the `/site` directory. This script ensures that relevant root-level files are included and clears the previous build:

```bash
# Clear existing /site directory
rm -rf site
```bash
# Clear existing /site directory to prevent conflicts
rm -rf site

# Loop through each language config file and build
mkdocs build -f docs/mkdocs.yml
for file in docs/mkdocs_*.yml; do
echo "Building MkDocs site with $file"
mkdocs build -f "$file"
done
```
# Build the default language site using the primary config file
mkdocs build -f docs/mkdocs.yml

3. To preview your site, initiate a simple HTTP server:
# Loop through each language-specific config file and build its site
for file in docs/mkdocs_*.yml; do
echo "Building MkDocs site with $file"
mkdocs build -f "$file"
done
```

```bash
cd site
python -m http.server
# Open in your preferred browser
```

- πŸ–₯️ Access the live site at `http://localhost:8000`.
3. To preview the complete multi-language site locally, navigate into the build output directory and start a simple [Python HTTP server](https://docs.python.org/3/library/http.server.html):
```bash
cd site
python -m http.server
# Open http://localhost:8000 in your preferred web browser
```
Access the live preview site at `http://localhost:8000`.

## πŸ“€ Deploying Your Documentation Site

Choose a hosting provider and deployment method for your MkDocs documentation:
To deploy your MkDocs documentation site, choose a hosting provider and configure your deployment method. Common options include [GitHub Pages](https://pages.github.com/), GitLab Pages, or other static site hosting services.

- Configure deployment settings within your `mkdocs.yml` file.
- Use the `mkdocs deploy` command specific to your chosen provider to build and deploy your site.

- Configure `mkdocs.yml` with deployment settings.
- Use `mkdocs deploy` to build and deploy your site.
* **GitHub Pages Deployment Example:**
If deploying to GitHub Pages, you can use the built-in command:

* ### GitHub Pages Deployment Example:
```bash
mkdocs gh-deploy
```

- Update the "Custom domain" in your repository's settings for a personalized URL.
After deployment, you might need to update the "Custom domain" settings in your repository's settings page if you wish to use a personalized URL.

![196814117-fc16e711-d2be-4722-9536-b7c6d78fd167](https://user-images.githubusercontent.com/26833433/210150206-9e86dcd7-10af-43e4-9eb2-9518b3799eac.png)
![GitHub Pages Custom Domain Setting](https://user-images.githubusercontent.com/26833433/210150206-9e86dcd7-10af-43e4-9eb2-9518b3799eac.png)

- For detailed deployment guidance, consult the [MkDocs documentation](https://www.mkdocs.org/user-guide/deploying-your-docs/).
- For detailed instructions on various deployment methods, consult the official [MkDocs Deploying your docs guide](https://www.mkdocs.org/user-guide/deploying-your-docs/).

## πŸ’‘ Contribute

We cherish the community's input as it drives Ultralytics open-source initiatives. Dive into the [Contributing Guide](https://docs.ultralytics.com/help/contributing/) and share your thoughts via our [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A heartfelt thank you πŸ™ to each contributor!

<!-- Pictorial representation of our dedicated contributor community -->
We deeply value contributions from the open-source community to enhance Ultralytics projects. Your input helps drive innovation! Please review our [Contributing Guide](https://docs.ultralytics.com/help/contributing/) for detailed information on how to get involved. You can also share your feedback and ideas through our [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A heartfelt thank you πŸ™ to all our contributors for their dedication and support!

![Ultralytics open-source contributors](https://raw.githubusercontent.com/ultralytics/assets/main/im/image-contributors.png)

We look forward to your contributions!

## πŸ“œ License

Ultralytics Docs presents two licensing options:
Ultralytics Docs are available under two licensing options to accommodate different usage scenarios:

- **AGPL-3.0 License**: Perfect for academia and open collaboration. Details are in the [LICENSE](https://github.com/ultralytics/docs/blob/main/LICENSE) file.
- **Enterprise License**: Tailored for commercial usage, offering a seamless blend of Ultralytics technology in your products. Learn more at [Ultralytics Licensing](https://www.ultralytics.com/license).
- **AGPL-3.0 License**: Ideal for students, researchers, and enthusiasts involved in academic pursuits and open collaboration. See the [LICENSE](https://github.com/ultralytics/docs/blob/main/LICENSE) file for full details. This license promotes sharing improvements back with the community.
- **Enterprise License**: Designed for commercial applications, this license allows seamless integration of Ultralytics software and [AI models](https://docs.ultralytics.com/models/) into commercial products and services. Visit [Ultralytics Licensing](https://www.ultralytics.com/license) for more information on obtaining an Enterprise License.

## βœ‰οΈ Contact

For bug reports and feature requests, navigate to [GitHub Issues](https://github.com/ultralytics/docs/issues). Engage with peers and the Ultralytics team on [Discord](https://discord.com/invite/ultralytics) for enriching conversations!
For bug reports, feature requests, and other issues related to the documentation, please use [GitHub Issues](https://github.com/ultralytics/docs/issues). For discussions, questions, and community support, join the conversation with peers and the Ultralytics team on our [Discord server](https://discord.com/invite/ultralytics)!

<br>
<div align="center">
Expand Down
Loading