diff --git a/README.md b/README.md index 285ae1a06e..349af15c88 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ ![Pulls](https://img.shields.io/docker/pulls/bluerobotics/blueos-core?label=Pulls) ![Size](https://img.shields.io/docker/image-size/bluerobotics/blueos-core?label=Size)](https://hub.docker.com/r/bluerobotics/blueos-core/tags) -BlueOS is a modular, robust, and efficient platform for managing a vehicle or robot from its [onboard computer](https://blueos.cloud/docs/hardware/required/onboard-computer/). It is the evolution of the Companion project, which aimed to route a vehicle's video stream and communications to its [control station computer](https://blueos.cloud/docs/hardware/required/control-computer/). Recognizing the need for a more sophisticated and scalable system, BlueOS was created from the ground up, embracing modularity to ensure portability, robust updating, and extensibility. +BlueOS is a modular, robust, and efficient platform for managing a vehicle or robot from its [onboard computer](https://blueos.cloud/docs/latest/integrations/hardware/required/onboard-computer/). It is the evolution of the Companion project, which aimed to route a vehicle's video stream and communications to its [control station computer](https://blueos.cloud/docs/latest/integrations/hardware/required/control-computer/). Recognizing the need for a more sophisticated and scalable system, BlueOS was created from the ground up, embracing modularity to ensure portability, robust updating, and extensibility.

@@ -26,7 +26,7 @@ BlueOS is a modular, robust, and efficient platform for managing a vehicle or ro ## Quick Links ⚡ - [Official documentation](https://blueos.cloud/docs/) -- [Installation](https://blueos.cloud/docs/stable/usage/installation/) +- [Installation](https://blueos.cloud/docs/latest/usage/installation/) - [Development documentation](https://blueos.cloud/docs/latest/development/overview/) - [Contributions](https://blueos.cloud/docs/latest/development/core/#contributions) - [Code of Conduct](./CoC.md) @@ -41,7 +41,7 @@ The development of BlueOS is driven by the following core principles: * **Designed to focus on what matters**, improving user access to information and controls with a human-friendly UI and UX * **Make complex tasks simpler** and improve ease of use by reusing design patterns from other applications (based on the [material UI guidelines](https://material.io/design/guidelines-overview)) * **Advanced error handling and detection**, making any problems clear to the user and developers, along with how to fix them -* **Simplify development**, providing full access to our [services API](https://blueos.cloud/docs/blueos/1.1/development/core/#services) and [modular development model](https://blueos.cloud/docs/blueos/1.1/development/overview/) +* **Simplify development**, providing full access to our [services API](https://blueos.cloud/docs/latest/development/core/#services) and [modular development model](https://blueos.cloud/docs/latest/development/overview/) * **Portable and flexible**, you should be able to run on a Raspberry Pi 3/4/5 or any SBC with Linux operating system, contributions are welcomed * **Highly functional with low CPU usage**, the entire system is built to run efficiently * **Developed on solid foundations**, critical parts or intensive workforce services are designed using the most advanced languages and features available for stability @@ -86,7 +86,7 @@ BlueOS provides generic support for a wide variety of terrestrial, aerial, and m ### Raspberry Pi and hardware preparation -For installations that need hardware configuration and preparation of the operating system, it´s highly recommended to use [the installation script](https://github.com/bluerobotics/BlueOS/blob/master/install) and customize it as necessary to perform the necessary changes for your system. +For installations that need hardware configuration and preparation of the operating system, it's highly recommended to use [the installation script](https://github.com/bluerobotics/BlueOS/blob/master/install) and customize it as necessary to perform the necessary changes for your system. ### Running BlueOS @@ -144,7 +144,7 @@ services: - /var/run/wpa_supplicant:/var/run/wpa_supplicant - /run/log/journal:/run/log/journal:ro - /var/log/journal:/var/log/journal:ro - - /home/patrick/.ssh:/home/pi/.ssh + - $HOME/.ssh:/home/pi/.ssh ``` The system should be accessible now via `0.0.0.0:80` or via the network using the IP address of the device.