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

More config file variable docs #102

Open
nmsutton opened this issue Apr 8, 2016 · 3 comments
Open

More config file variable docs #102

nmsutton opened this issue Apr 8, 2016 · 3 comments

Comments

@nmsutton
Copy link

nmsutton commented Apr 8, 2016

Documentation explaining what each variable represents in configuration files for developers. For instance:

[position] - contains information about position of all particles e.g.
a b c d // a is …, b is …, c is …, d is … <--- Add this

Also optional is a description of the minimum required data in such files to create objects in the scene.

@nmsutton
Copy link
Author

nmsutton commented Apr 9, 2016

I have made some progress on the docs but certainly much more remains. The current version is online here. The github repo is availible here. I would appreciate any contributions!

@slarson
Copy link
Member

slarson commented Apr 15, 2016

@nmsutton great start. How would you feel about forking the https://github.com/openworm/sibernetic_config_gen repo directly, adding your docs in as a subdirectory, and doing a pull request back in? Or at minimum, let's add some kind of pointer to your docs from that repo in the readme; just so people can start to find it :) Thanks!

@nmsutton
Copy link
Author

@slarson thanks for your outstanding work on this project! I have now forked and submitted a pull, I appreciate your interest in me doing that.

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