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

Try to make the readme a bit more pedagogic? #38

Open
3 tasks
gnzlbg opened this issue Feb 7, 2018 · 1 comment
Open
3 tasks

Try to make the readme a bit more pedagogic? #38

gnzlbg opened this issue Feb 7, 2018 · 1 comment

Comments

@gnzlbg
Copy link

gnzlbg commented Feb 7, 2018

Issue: the only line in the whole readme that shows how to execute dinghy is the very last line that states cargo dinghy test.

  • First: add a table of contents.

  • Second: add a quick start guide, with two self contained examples, one for ios and one for androd that shows how to get the tests of a very basic Rust project to run. By self contained I mean that somebody that does this for the first time shouldn't need to google anything (for example, how to download, install, start the simulators, etc.).

  • Put "more advanced" features afterwards. Like how to ssh into a phone, copy files, etc. Try to add examples that work (I know this is hard, or might not always be possible, but maybe one can copy files or ssh into a simulator?).

Also, I think dinghy could be very useful for CI on travis against the ios-simulator and the android simulators. It would be great if the travis-ci setup could have some build bots that run the tests of an example project in both (ideally across different Xcode versions and Android NDK versions to make sure dinghy works across the board).

@kali
Copy link
Collaborator

kali commented Feb 9, 2018

Thanks for the interest and the comments. We are actually doing a relatively heavy refactoring of dinghy and how it interacts with toolchains, and have just started updating the documentation.

The quick-start idea guide is interesting. The initial focus was ios on device, and the minimal path to get something working in this configuration is awful. A run against an ios and/or an android device might be more suited for a quick-start guide, and we are considering it.

We also like the idea of a "ready-to-use" android-on-travis guide (or ios sim), so we will most definitely give it a try.

Thanks !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants