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

Documenting Make file #28

Open
MartinHeroux opened this issue Jun 26, 2015 · 2 comments
Open

Documenting Make file #28

MartinHeroux opened this issue Jun 26, 2015 · 2 comments

Comments

@MartinHeroux
Copy link
Contributor

Disclaimer.
I am sorry if this is not the right location for such a request.

Context.
The material is very useful and informative, and I especially like the way you generate a pdf document of all the content. As someone starting out with python, git and make, creating this type of pdf shows another great benefit of this type of work flow.

Issue.
At some point would it be possible to add some documentation to the make file. I sort of follow the code, but some additional documentation would help users of the code possibly be able to use a similar approach on their own projects.

Cheers,

Marty

@burcugrbz
Copy link

Thank you

 On Saturday, June 27, 2015 12:28 AM, Martin Heroux <notifications@github.com> wrote:

Disclaimer.
I am sorry if this is not the right location for such a request. Context.
The material is very useful and informative, and I especially like the way you generate a pdf document of all the content. As someone starting out with python, git and make, creating this type of pdf shows another great benefit of this type of work flow.Issue.
At some point would it be possible to add some documentation to the make file. I sort of follow the code, but some additional documentation would help users of the code possibly be able to use a similar approach on their own projects. Cheers,Marty—
Reply to this email directly or view it on GitHub.

@jrjohansson
Copy link
Owner

The Makefile could, for example, be documented with in-file comments or a separate markdown file, like Readme.md.

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

3 participants