diff --git a/README.md b/README.md index b95a86d..4af36b8 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ -# What's TVM +# TVM -TVM is the acronym for: +TVM is a tool that allows you to manage several Tutor development environments so that they work in isolation, and you can work on different projects with independent Tutor versions and configurations. -- **Tutor Version Manager:** manages the version of the tutor. -- **Tutor enVironment Manager:** for creating project-based environments with tutor. +TVM is also the acronym for: + +- Tutor Version Manager: manages the version of Tutor. +- Tutor enVironment Manager: for creating project-based environments with Tutor. # Installing TVM @@ -13,61 +15,67 @@ Open a terminal and run: pip install git+https://github.com/eduNEXT/tvm.git ``` -You can verify the installation with: +Verify the installation: ```bash tvm --version ``` -## Upgrading TVM (ToDo) +# Getting Started -Currently, there isn't a command to do it, if you want to upgrade it, please install it again. +Create and activate a new project with the following steps: -# Usage +1. Install the version of Tutor you want to use with TVM. -## Quickstart with TVM as enVironment Manager +```bash +tvm install -Create and activate a new project with: +# For example: +# tvm install v14.0.0 +``` -1. Install a tutor version with tutor version manager +2. Create a new project with TVM. ```bash -tvm install v +tvm project init + +# For example: +# tvm project init tvm-test v14.0.0 ``` -2. Create a new project with tutor environment manager +3. Open the project folder. ```bash -tvm project init v +cd ``` -3. Open the project folder +4. Activate the project environment. ```bash -cd +source .tvm/bin/activate ``` -4. Activate the project environment +5. Run your project. ```bash -source .tvm/bin/activate +tutor local quickstart ``` -Now you can start configuring and using your tutor instance, reference [tutor official documentation](https://docs.tutor.overhang.io/index.html). +You can start configuring and using your Tutor instance. + +## Next steps -## User Guide +If you want to see what else you can do, access **the complete TVM documentation**: https://tvm.docs.edunext.co -If you want to see what else you can do, access the complete guide of: +# Getting Help -- [**Tutor Version Manager**](/docs/TutorVersionManager.rst) +- To report a bug or ask for a feature, go to the TVM GitHub issues: https://github.com/eduNEXT/tvm/issues -- [**Tutor enVironment Manager**](/docs/TutorEnvironmentManager.rst) +- To get support, go to the TVM Github discussion forum: https://github.com/eduNEXT/tvm/discussions # How to Contribute -Contributions are welcome!. See our [CONTRIBUTING](https://github.com/edunext/tvm/blob/master/CONTRIBUTING.md) -file for more information – it also contains guidelines for how to maintain high code quality, which will make your -contribution more likely to be accepted. +Contributions are welcome! See our [CONTRIBUTING](https://github.com/edunext/tvm/blob/master/CONTRIBUTING.md) file for more information – it also contains guidelines for how to maintain high code quality, which will make your contribution more likely to be accepted. # License diff --git a/docs/source/tvm_quickstart.rst b/docs/source/tvm_quickstart.rst index bc036e8..92a6081 100644 --- a/docs/source/tvm_quickstart.rst +++ b/docs/source/tvm_quickstart.rst @@ -83,5 +83,5 @@ Step by Step Next Steps ----------- -- To do more with TVM, check `Tutorials `_ or `TVM Topic Guides `_. +- To do more with TVM, check :doc:`Tutorials ` or :doc:`TVM Topic Guides `. - To know more about Tutor, check `Tutor documentation `_. diff --git a/docs/source/tvm_topic_guides/environment_manager.rst b/docs/source/tvm_topic_guides/environment_manager.rst index db9902a..b527caa 100644 --- a/docs/source/tvm_topic_guides/environment_manager.rst +++ b/docs/source/tvm_topic_guides/environment_manager.rst @@ -109,4 +109,4 @@ Pip Related -------- -- `TVM as Tutor Manager `_. +- :doc:`TVM as Tutor Manager `. diff --git a/docs/source/tvm_topic_guides/version_manager.rst b/docs/source/tvm_topic_guides/version_manager.rst index cef5caf..5899c0e 100644 --- a/docs/source/tvm_topic_guides/version_manager.rst +++ b/docs/source/tvm_topic_guides/version_manager.rst @@ -139,4 +139,4 @@ Pip Related -------- -- `TVM as Environment Manager `_. +- :doc:`TVM as Environment Manager `. diff --git a/docs/source/tvm_tutorials/creating_two_dev_env.rst b/docs/source/tvm_tutorials/creating_two_dev_env.rst index 57f6d6b..5bec171 100644 --- a/docs/source/tvm_tutorials/creating_two_dev_env.rst +++ b/docs/source/tvm_tutorials/creating_two_dev_env.rst @@ -75,4 +75,4 @@ Step by Step Next Steps ----------- -- To do more with TVM, check `TVM Topic Guides `_. +- To do more with TVM, check :doc:`TVM Topic Guides `.