Skip to content
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.

Sign up for GitHub

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

Jump to bottom

README: Move the installation parts to INSTALLATION.md file #155

Open
2 tasks done
MithunKinarullathil opened this issue May 13, 2022 · 1 comment
Open
2 tasks done

README: Move the installation parts to INSTALLATION.md file #155

MithunKinarullathil opened this issue May 13, 2022 · 1 comment
Assignees
@MithunKinarullathil
Labels
documentation Improvements or additions to documentation enhancement New feature or request known issue Tag for issues that are known to the development team

Comments

@MithunKinarullathil
Copy link
Collaborator

Have you checked our docs before proceeding?

Issue Description

Currently, README is getting very long with a lot of items. It would be better to move the installation part to an installation.md file and link it in the README. Thanks to @AlexFernandes-MOVAI for the suggestion.

Steps to Reproduce

  1. Open the current README

Actual Behaviour

A bit long document where the user can get lost.

Expected Behaviour

Separate files for specific instructions, such as the installation procedure.

Screenshots/GIFs

Versions

  • movai-flow: N/A
  • movai-ide: N/A

Possible workarounds

Additional Details

  • Installed packages: N/A
@MithunKinarullathil MithunKinarullathil added documentation Improvements or additions to documentation enhancement New feature or request known issue Tag for issues that are known to the development team labels May 13, 2022
@MithunKinarullathil MithunKinarullathil self-assigned this May 13, 2022
@guide-bot
Copy link

guide-bot bot commented May 13, 2022

Thanks for opening this Issue!
We need you to:

  1. Fill out the description.

    Action: Edit description and replace <!- ... --> with actual values.

@MithunKinarullathil MithunKinarullathil mentioned this issue May 13, 2022
Merged
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MithunKinarullathil MithunKinarullathil

Labels
documentation Improvements or additions to documentation enhancement New feature or request known issue Tag for issues that are known to the development team
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@MithunKinarullathil