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

Add Rust documentation #126

Open
tcr opened this issue Oct 17, 2016 · 4 comments
Open

Add Rust documentation #126

tcr opened this issue Oct 17, 2016 · 4 comments

Comments

@tcr
Copy link
Member

tcr commented Oct 17, 2016

We should update docs to include instructions from tessel-rust, now that we have an out of box experience for remote and local compilation with t2-cli.

@richa-coder
Copy link

Can i start with this?

@tcr
Copy link
Member Author

tcr commented Oct 18, 2016

@richa-coder Yeah absolutely!

We want to fill out the "Rust" section of the Supported Languages page. The existing content is old and talks about what we planned to do for Rust support. We can scrap the paragraph that's there ("The Tessel team is working toward first-class support for Rust...")

Now that we added Rust support to Tessel, we want to give instructions on how to use it. This "Quickstart" section summarizes all the information you'd need: https://github.com/tessel/tessel-rust

The Quickstart is good, but it would be even better if the documentation described what each command did:

  • cargo tessel sdk install installs the Rust cross-compiler
  • t2 init --lang=rust writes out the "blinking lights" example
  • t2 run blinky runs the "blinky" binary on Tessel
  • t2 run blinky --rustcc runs the "blinky" binary, compiling it using the cross-compilation server

If there's anything you want more detail on, just ask. The goal is just to get the info in the right place and make it understandable to someone reading the guide for the first time.

@richa-coder
Copy link

richa-coder commented Oct 18, 2016

so you want me to remove rust section from Supported languages and just
give a bit explanation on each commands for the quickstart page?

@Frijol
Copy link
Member

Frijol commented Oct 21, 2016

@richa-coder until we reach official full Rust support (we're not there yet) I think it's best if we keep the t2-docs information about Rust commands in the Supported Languages page and maintain the Work In Progess marker in the heading.

I think @tcr is suggesting that we pull information from the tessel-rust repo (specifically the Quickstart section) into the Supported Languages page so people don't have to search for it as much. And separately, it would be good to add documentation on the specific commands to the Quickstart in both locations. @tcr am I reading that right?

Frijol added a commit that referenced this issue Feb 5, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants