-
Notifications
You must be signed in to change notification settings - Fork 106
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
Improve beginner experience #645
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
That looks awesome!!! Thanks! Really like the new performance review diagram :) I think this can already be merged :) |
Cool! Let met update the links and I will merge it! |
Hennzau
added
documentation
Improvements or additions to documentation
enhancement
New feature or request
windows
labels
Sep 9, 2024
haixuanTao
reviewed
Sep 9, 2024
haixuanTao
approved these changes
Sep 9, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adding a links for the benchmark as it is a common asked question.
Co-authored-by: Haixuan Xavier Tao <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Objective
Hi! This PR proposes several changes to the installation process,
README.md
, and examples to make it easier for beginners to get started with Dora.Installation
The
install.sh
script for Linux and macOS now automatically detects the user's terminal and asks if they want to add.dora/bin
to their PATH automatically.A new
install.ps1
script does the same for Windows. The following command (note: it doesn't work yet because this PR hasn't been merged into the main branch, so the path needs to be adapted) works regardless of whether the user is in CMD, bash, or PowerShell (this helps avoid potential errors):powershell -c "irm https://raw.githubusercontent.com/dora-rs/dora/main/install.ps1 | iex"
=> I believe having a standalone installation script will help convince more beginners to use Dora (especially among students/teachers). Using
crates.io
requires several steps, particularly on Windows: installing Rustup, simultaneously installing MSVC, and then installingdora-cli
. For many who are not Rust developers, this can involve too many steps (especially regarding MSVC, since the Visual Installer interface is not very intuitive, and beginners might not know what to install).README.md
I was inspired by existing GitHub projects to propose a clearer
README.md
that quickly highlights the important steps of the project: Highlights, Installation, and Documentation/Getting Started.Examples
I haven't worked on this part yet, but I think it's necessary to rework our
examples
folder. I find it easy to get lost in it as it currently feels more like atests
directory than examples meant to guide a user.What would be helpful is:
Creating more explicit examples like
rust-talker-listener
,python-video-capture
,rust-speech-to-text
,python-ros2-bridge
,multiple-machine-talker-listener
, etc., instead of justc++-dataflow
,python-dataflow
, etc.Automatically integrating all our examples into the
CI
.For the
python
examples, to facilitate execution withrun.rs
scripts, it might be worth considering usinguv
(https://github.com/astral-sh/uv), as they offer a crate that allows managing an entirepython
installation,venv
,dependencies
from Rust. This might be simpler than having to find a Python binary, install everything, etc.