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.

Sign up for GitHub

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

Jump to bottom

Extend README Documentation #21

Open
5 of 11 tasks
jackcarlisle opened this issue Feb 8, 2017 · 5 comments
Open
5 of 11 tasks

Extend README Documentation #21

jackcarlisle opened this issue Feb 8, 2017 · 5 comments
Labels
discuss Share your constructive thoughts on how to make progress with this issue enhancement New feature or enhancement of existing functionality help wanted If you can help make progress with this issue, please comment!

Comments

@jackcarlisle
Copy link
Member

jackcarlisle commented Feb 8, 2017 •
edited by iteles
Loading

Currently the README.md gives a good introduction by covering the basics. I feel as though this should be extended further to include more things integral to a functional programming language:

  • immutability
  • recursive functions
  • partial application
  • heads and tails

Does anyone have any thoughts on things to include?

Initial list of topics to add or extend within the documentation:
@jackcarlisle jackcarlisle added enhancement New feature or enhancement of existing functionality help wanted If you can help make progress with this issue, please comment! question A question needs to be answered before progress can be made on this issue labels Feb 8, 2017
@nelsonic nelsonic added the discuss Share your constructive thoughts on how to make progress with this issue label Feb 8, 2017
@nelsonic
Copy link
Member

@jackcarlisle adding that checklist to the issue description (first comment) will show a progress bar... 😉

@jackcarlisle jackcarlisle self-assigned this Feb 10, 2017
@jackcarlisle jackcarlisle added the in-progress An issue or pull request that is being worked on by the assigned person label Feb 10, 2017
jackcarlisle added a commit that referenced this issue Feb 10, 2017
@jackcarlisle
step 1 generating a project #21
b6cc38c
@jackcarlisle jackcarlisle mentioned this issue Feb 10, 2017
Merged
1 task
jackcarlisle added a commit that referenced this issue Feb 10, 2017
@jackcarlisle
hello world #21
409f892
jackcarlisle added a commit that referenced this issue Feb 10, 2017
@jackcarlisle
extends animals module #21
9bcd303
jackcarlisle added a commit that referenced this issue Feb 10, 2017
@jackcarlisle
adds more examples #21
ccb00fd
jackcarlisle added a commit that referenced this issue Feb 10, 2017
@jackcarlisle
finishes example functionality #21
1e3c3f0
@jackcarlisle
Copy link
Member Author

screen shot 2017-02-10 at 16 36 21

@jackcarlisle
Copy link
Member Author

screen shot 2017-02-10 at 16 39 02

screen shot 2017-02-10 at 16 39 26

jackcarlisle added a commit that referenced this issue Feb 10, 2017
@jackcarlisle
adds documentation section #21
f1d221e
jackcarlisle added a commit that referenced this issue Feb 10, 2017
@jackcarlisle
adds more documentation on documentation #21
9f8bd8f
jackcarlisle added a commit that referenced this issue Feb 10, 2017
@jackcarlisle
fixes markdown #21
c7cda42
@jackcarlisle jackcarlisle mentioned this issue Feb 10, 2017
Merged
1 task
jackcarlisle added a commit that referenced this issue Feb 14, 2017
@jackcarlisle
adds information to the readme on testing with Elixir #21
748ce19
@jackcarlisle jackcarlisle mentioned this issue Feb 14, 2017
Merged
1 task
jackcarlisle added a commit that referenced this issue Feb 14, 2017
@jackcarlisle
adds information on maps to the readme #21
f1b2ea1
@jackcarlisle jackcarlisle mentioned this issue Feb 14, 2017
Merged
jackcarlisle added a commit that referenced this issue Feb 14, 2017
@jackcarlisle
changes the note #21
3267510
jackcarlisle added a commit that referenced this issue Feb 14, 2017
@jackcarlisle
changes the style of the note #21
783c52d
jackcarlisle added a commit that referenced this issue Feb 14, 2017
@jackcarlisle
shortens the h4 for the pipe operator #21
a2d3e5f
jackcarlisle added a commit that referenced this issue Feb 14, 2017
@jackcarlisle
re-formats readme #21
f3a9723
jackcarlisle added a commit that referenced this issue Feb 14, 2017
@jackcarlisle
resolves merge conflicts #21
b3582b1
@jruts jruts closed this as completed in e41275c Feb 19, 2017
@nelsonic nelsonic reopened this Feb 20, 2017
@Jbarget
Copy link
Member

Jbarget commented Mar 1, 2017

We (@des-des and I) have been using iex -S mix to run the shell within the context of your app. shall i make a pull request outlining the difference between iex and the command above?

@nelsonic
Copy link
Member

nelsonic commented Mar 1, 2017

@Jbarget good plan. 👍

@jackcarlisle jackcarlisle removed their assignment Mar 3, 2017
@iteles iteles removed in-progress An issue or pull request that is being worked on by the assigned person question A question needs to be answered before progress can be made on this issue labels Sep 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
discuss Share your constructive thoughts on how to make progress with this issue enhancement New feature or enhancement of existing functionality help wanted If you can help make progress with this issue, please comment!
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@nelsonic @iteles @Jbarget @jackcarlisle