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

Descriptive README, addresses #108 #110

Merged
merged 16 commits into from Jan 18, 2014
Merged

Conversation

chrisdembia
Copy link
Member

Addresses #108. Other relevant issues: #49, #50, #60.

  • Add travis build status icon.
  • Show cool GIF made by Sam Flores (will not show in this PR because I'm using links that'll only be valid once the PR is accepted. To see the GIF in action, see this).
  • Provide source code for double pendulum example.
  • List a bunch of links for where people can find forums, instructions, etc.
  • List project dependencies.
  • List basic command-line build/install instructions.
  • List other dynamics engines.

I'm overall dissatisfied with the build/install instructions I've put in the README. I realize our userbase is largely Windows users, but it doesn't feel possible to give Windows users anything too useful in the README. It seems that the README's usually are suited for people using a terminal.

Unfortunately, I don't have too much more time to work on this.

@chrisdembia
Copy link
Member Author

Also, the dependency information may be wrong for Windows and Mac OS X. I didn't try to check; I took that info from doc/INSTALL.txt

Another thing: hopefully @sherm1 can refine the list of features.

@sherm1
Copy link
Member

sherm1 commented Jan 18, 2014

Great start -- thanks. The animated gif is a nice touch! Is that really 11000 bodies?

I'll merge this and then we can tweak it more as time permits. Much appreciated, Chris.

sherm1 added a commit that referenced this pull request Jan 18, 2014
Descriptive README, addresses #108
@sherm1 sherm1 merged commit d6b9a9f into simbody:master Jan 18, 2014
@chrisdembia
Copy link
Member Author

Great. Thanks. I got the figure from you in #49. It's a really cool video!

@chrisdembia chrisdembia deleted the readme branch January 18, 2014 08:06
@sherm1
Copy link
Member

sherm1 commented Jan 18, 2014

I see -- those were actually two separate comments, ambiguously worded. I should have said: (1) Sam Flores holds the record with an 11000-body chain, and (2) He also makes cool movies like the Simbios-spelling RNAs.

I actually don't know how many bodies were used in that movie so I changed the text to say "thousands".

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

Successfully merging this pull request may close these issues.

None yet

2 participants