Commit d450ac94 authored by Mayank Mittal's avatar Mayank Mittal

adds info on github discussions

parent 5d2ae535
......@@ -17,6 +17,22 @@ Isaac Orbit (or *orbit* in short) is a unified and modular framework for robot l
Please refer our [documentation page](https://isaac-orbit.github.io/orbit) to learn more about the installation steps, features and tutorials.
## Contributing to Orbit
We wholeheartedly welcome contributions from the community to make this framework mature and useful for everyone. These may happen in
form of bug reports, feature requests, or code contributions. For details, please check our [contribution guidelines](https://isaac-orbit.github.io/orbit/source/refs/contributing.html).
## Troubleshooting
Please see the [troubleshooting](https://isaac-orbit.github.io/orbit/source/refs/troubleshooting.html) section for common fixes or [submit an issue](https://github.com/NVIDIA-Omniverse/orbit/issues).
For issues related to Isaac Sim, we recommend checking its [documentation](https://docs.omniverse.nvidia.com/app_isaacsim/app_isaacsim/overview.html), or opening a question on its [forums](https://forums.developer.nvidia.com/c/agx-autonomous-machines/isaac/67).
## Support
* Please use GitHub [Discussions](https://github.com/NVIDIA-Omniverse/Orbit/discussions) for discussing ideas, asking questions, and requests for new features.
* Github [Issues](https://github.com/NVIDIA-Omniverse/orbit/issues) should only be used to track executable pieces of work with a definite scope and a clear deliverable. These can be fixing bugs, documentation issues, new features, or general updates.
## Acknowledgement
NVIDIA Isaac Sim is available freely under [individual license](https://www.nvidia.com/en-us/omniverse/download/). For more information about its license terms, please check [here](https://docs.omniverse.nvidia.com/app_isaacsim/common/NVIDIA_Omniverse_License_Agreement.html#software-support-supplement).
......@@ -25,7 +41,7 @@ ORBIT framework is released under [BSD-3 License](LICENSE). The license files of
## Citation
If you use **`orbit`** in your work, please cite:
Please cite [this paper](https://arxiv.org/abs/2301.04195) if you use this framework in your work:
```
@misc{mittal2023orbit,
......
......@@ -5,7 +5,7 @@ We wholeheartedly welcome contributions to the project to make the framework mor
and useful for everyone. These may happen in forms of:
* Bug reports: Please report any bugs you find in the `issue tracker <https://github.com/NVIDIA-Omniverse/orbit/issues>`__.
* Feature requests: Please suggest new features you would like to see in the `issue tracker <https://github.com/NVIDIA-Omniverse/orbit/issues>`__.
* Feature requests: Please suggest new features you would like to see in the `discussions <https://github.com/NVIDIA-Omniverse/Orbit/discussions>`__.
* Code contributions: Please submit a `pull request <https://github.com/NVIDIA-Omniverse/orbit/pulls>`__.
* Bug fixes
......@@ -14,6 +14,16 @@ and useful for everyone. These may happen in forms of:
* Tutorials and tutorial improvements
.. note::
We prefer GitHub `discussions <https://github.com/NVIDIA-Omniverse/Orbit/discussions>`_ for discussing ideas,
asking questions, conversations and requests for new features.
Please use the
`issue tracker <https://github.com/NVIDIA-Omniverse/orbit/issues>`_ only to track executable pieces of work
with a definite scope and a clear deliverable. These can be fixing bugs, new features, or general updates.
Contributing Code
-----------------
......@@ -34,7 +44,7 @@ After sending a pull request, the maintainers will review your code and provide
Please ensure that your code is well-formatted, documented and passes all the tests.
.. note::
.. tip::
It is important to keep the pull request as small as possible. This makes it easier for the
maintainers to review your code. If you are making multiple changes, please send multiple pull requests.
......
......@@ -4,10 +4,13 @@ Development Roadmap
Following is a loosely defined roadmap for the development of the codebase. The roadmap is subject to
change and is not a commitment to deliver specific features by specific dates or in the specified order.
Some of the features listed below are already implemented in the codebase, but are not yet documented
Some of the features listed are already implemented in the codebase, but are not yet documented
and/or tested. We will be working on improving the documentation and testing of these features in the
coming months.
If you have any questions or suggestions, let us know on
`GitHub discussions <https://github.com/NVIDIA-Omniverse/Orbit/discussions>`_.
**January 2023**
* |check_| Experimental functional API
......@@ -37,6 +40,7 @@ coming months.
**February 2023**
* |uncheck| Add APIs for rough terrain generation
* |uncheck| Extend MDP manager classes to use sensor observations
* |uncheck| Example on using the APIs in an Omniverse extension
* Supported motion generators
......@@ -64,7 +68,7 @@ coming months.
* |uncheck| Add functional versions of all environments
* Supported sensors
* |uncheck| Multi-camera support
* |uncheck| Cameras (parallelized)
* Included environments
......
......@@ -21,7 +21,7 @@ Downloading pre-built binaries
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Please follow the Isaac Sim
`documentation <https://docs.omniverse.nvidia.com/app_isaacsim/app_isaacsim/install_basic.html>`__
`documentation <https://docs.omniverse.nvidia.com/app_isaacsim/app_isaacsim/install_workstation.html>`__
to install the latest Isaac Sim release.
To check the minimum system requirements,refer to the documentation
......@@ -112,9 +112,11 @@ Organizing the workspace
- Clone the ``orbit`` repository into your workspace:
.. code:: bash
# For public users
git clone git@github.com:NVIDIA-Omniverse/orbit.git
# Option 1: With SSH
git clone git@github.com:NVIDIA-Omniverse/orbit.git
# Option 2: With HTTPS
git clone https://github.com/NVIDIA-Omniverse/Orbit.git
- Set up a symbolic link between the installed Isaac Sim root folder
and ``_isaac_sim`` in the ``orbit``` directory. This makes it convenient
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment