diff --git a/README.md b/README.md index fe4e9cc72d..6798a6e086 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,17 @@ -Isaac Orbit (or *orbit* in short) is a unified and modular framework for robot learning powered by [NVIDIA Isaac Sim](https://docs.omniverse.nvidia.com/app_isaacsim/app_isaacsim/overview.html). It offers a modular design to easily and efficiently create robotic environments with photo-realistic scenes, and fast and accurate simulation. +Isaac Orbit (or *orbit* in short) is a unified and modular framework for robot learning powered by [NVIDIA Isaac Sim](https://docs.omniverse.nvidia.com/app_isaacsim/app_isaacsim/overview.html). It offers a modular design to easily and efficiently create robotic environments with photo-realistic scenes and fast and accurate simulation. -Please refer our [documentation page](https://isaac-orbit.github.io/orbit) to learn more about the installation steps, features and tutorials. +Please refer to our [documentation page](https://isaac-orbit.github.io/orbit) to learn more about the installation steps, features, and tutorials. + +## ⚠️ Annoucement (22.09.2023) + +We are currently in a phase of heavy development, and our team is actively working on various aspects of the framework to enhance its modularity and overall functionality. We understand the anticipation for a new release and assure you that we are working diligently towards it. While we have yet to set an exact release date to share, we are targeting a release in early October 2023. We believe that the improvements we are making will be well worth the wait. + +For more details, please check the post here: https://github.com/NVIDIA-Omniverse/Orbit/discussions/106 + +--- ## Contributing to Orbit diff --git a/docs/source/setup/installation.rst b/docs/source/setup/installation.rst index 5759dab8e8..8c36bd1e4c 100644 --- a/docs/source/setup/installation.rst +++ b/docs/source/setup/installation.rst @@ -176,8 +176,17 @@ running the following on your terminal: # note: execute the command from where the `orbit.sh` executable exists # option1: for bash users echo -e "alias orbit=$(pwd)/orbit.sh" >> ${HOME}/.bashrc + source ${HOME}/.bashrc + # option2: for zshell users echo -e "alias orbit=$(pwd)/orbit.sh" >> ${HOME}/.zshrc + source ${HOME}/.zshrc + +To finalize the installation, please run: + +.. code:: bash + + orbit --install Setting up the environment ~~~~~~~~~~~~~~~~~~~~~~~~~~