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.

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

Move installation instructions to subpage #870

Merged
merged 2 commits into from
Nov 16, 2023

Conversation

fmauch
Copy link
Collaborator

@fmauch fmauch commented Oct 30, 2023

Apparently, having the build instructions so prominent on the main page seems to motivate people to build from source instead of installing the binary packages. This change simplifies the main repo page in order to show how to install and quickstart directly, linking to the full instructions from our sphinx doc.

@urrsk as discussed

README.md Outdated Show resolved Hide resolved
Copy link
Member

@urrsk urrsk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, but see my comment

Apparently, having the build instructions so prominent on the main page
seems to motivate people to build from source instead of installing the
binary packages. This change simplifies the main repo page in order to
show how to install and quickstart directly, linking to the full instructions
from our sphinx doc.
This example should be ready-to-go when using the URSim example.
Copy link
Collaborator

@RobertWilbrandt RobertWilbrandt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like a good change to me, making the front README less cluttered for non-expert users.

@RobertWilbrandt RobertWilbrandt merged commit 202a70c into UniversalRobots:main Nov 16, 2023
8 of 11 checks passed
mergify bot pushed a commit that referenced this pull request Nov 16, 2023
* Move installation instructions to subpage

Apparently, having the build instructions so prominent on the main page
seems to motivate people to build from source instead of installing the
binary packages. This change simplifies the main repo page in order to
show how to install and quickstart directly, linking to the full instructions
from our sphinx doc.

* More explicit copy_paste example

This example should be ready-to-go when using the URSim example.

(cherry picked from commit 202a70c)
mergify bot pushed a commit that referenced this pull request Nov 16, 2023
* Move installation instructions to subpage

Apparently, having the build instructions so prominent on the main page
seems to motivate people to build from source instead of installing the
binary packages. This change simplifies the main repo page in order to
show how to install and quickstart directly, linking to the full instructions
from our sphinx doc.

* More explicit copy_paste example

This example should be ready-to-go when using the URSim example.

(cherry picked from commit 202a70c)

# Conflicts:
#	README.md
fmauch added a commit that referenced this pull request Apr 16, 2024
* Move installation instructions to subpage

Apparently, having the build instructions so prominent on the main page
seems to motivate people to build from source instead of installing the
binary packages. This change simplifies the main repo page in order to
show how to install and quickstart directly, linking to the full instructions
from our sphinx doc.

* More explicit copy_paste example

This example should be ready-to-go when using the URSim example.

(cherry picked from commit 202a70c)

# Conflicts:
#	README.md
fmauch added a commit that referenced this pull request Apr 16, 2024
* Move installation instructions to subpage (#870)

Apparently, having the build instructions so prominent on the main page
seems to motivate people to build from source instead of installing the
binary packages. This change simplifies the main repo page in order to
show how to install and quickstart directly, linking to the full instructions
from our sphinx doc.

* More explicit copy_paste example

This example should be ready-to-go when using the URSim example.

* Make things equal to main branch

---------

Co-authored-by: Felix Exner (fexner) <exner@fzi.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants