Skip to content

Export - add readme with exporters information #1636

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

Merged
merged 1 commit into from
Apr 5, 2016

Conversation

0xc0170
Copy link
Contributor

@0xc0170 0xc0170 commented Mar 27, 2016

Adding readme with exporters information. What should be the format ? Should it be json, yaml or just simple text file with predefined format.

Current format in exporter.txt:

project_generator = true/false # if progen is used
# if progen is true, then version is added
project_generator version = x.x.x

Should fix #1617. For more info about getting the module version: http://python-packaging-user-guide.readthedocs.org/en/latest/single_source_version/

@bridadan @sg-

@bridadan
Copy link
Contributor

My knee-jerk reaction would be JSON, but based on discussions I had with @sg- today, JSON might not be the right choice because it lacks comment support.

So I would vote YAML because it is machine readable and it supports comments for documentation.

@0xc0170
Copy link
Contributor Author

0xc0170 commented Mar 30, 2016

OK, I'll look at YAML stucture for this info

@0xc0170 0xc0170 force-pushed the fix_#1617 branch 3 times, most recently from 341a181 to 1a9e293 Compare April 4, 2016 21:45
Exporters should provide additional information - what templates
are they using. For progen, it should be version, and we might add more
information later.
@0xc0170
Copy link
Contributor Author

0xc0170 commented Apr 4, 2016

Changed to yaml file.

# progen active
project_generator:
  active: true
  version: 0.8.13
project_generator_definitions:
  version: 0.2.11
# progen not active
project_generator:
  active: false

This is part of the exported project.

@bridadan
Copy link
Contributor

bridadan commented Apr 4, 2016

That's looking good

For the sake of asking every question, would it make sense to move the project_generator_definitions key under the project_generator dictionary?

project_generator:
  active: true
  version: 0.8.13
  project_generator_definitions:
    version: 0.2.11

@0xc0170
Copy link
Contributor Author

0xc0170 commented Apr 5, 2016

Done, progen def are under progen if progen is active.

@0xc0170 0xc0170 merged commit c9bf785 into ARMmbed:master Apr 5, 2016
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.

Exported project - should contain readme with some useful information
2 participants