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

doc: README #13

Closed
10 tasks done
mmcloughlin opened this issue Dec 31, 2018 · 3 comments
Closed
10 tasks done

doc: README #13

mmcloughlin opened this issue Dec 31, 2018 · 3 comments
Milestone
Initial Release

Comments

@mmcloughlin
Copy link
Owner

mmcloughlin commented Dec 31, 2018 •
edited

Need a full README with all the usual sections.

  • Title, tagline
  • Logo
  • Purchase logo icon (https://thenounproject.com/term/avocado/956339)
  • Warning about experimental status
  • Description
  • Installation
  • Usage/Quick start: add example
  • "Tour" of features: with more links to examples
  • Contributing
  • License
@mmcloughlin mmcloughlin added this to the Initial Release milestone Dec 31, 2018
mmcloughlin added a commit that referenced this issue Jan 3, 2019
@mmcloughlin
meta: add logo
8a820ac 
Update #13
mmcloughlin added a commit that referenced this issue Jan 3, 2019
@mmcloughlin
meta: adjust logo size
a882627 
Updates #13
mmcloughlin added a commit that referenced this issue Jan 4, 2019
@mmcloughlin
doc: move badges
ce1b0bb 
Updates #13
mmcloughlin added a commit that referenced this issue Jan 4, 2019
@mmcloughlin
doc: add quick start to README
e0c1ed5 
Updates #13
mmcloughlin added a commit that referenced this issue Jan 4, 2019
@mmcloughlin
doc: "Contributing" section in README
0594af9 
Updates #13
mmcloughlin added a commit that referenced this issue Jan 4, 2019
@mmcloughlin
doc: add description to README
91e048f 
Updates #13
@mmcloughlin
Copy link
Owner Author

More examples added in fa7b5ed

mmcloughlin added a commit that referenced this issue Jan 4, 2019
@mmcloughlin
doc: link to examples directory in README
52b6e2c 
Updates #13
mmcloughlin added a commit that referenced this issue Jan 5, 2019
@mmcloughlin
doc: fix broken links in README
d54d413 
Updates #13
mmcloughlin added a commit that referenced this issue Jan 7, 2019
@mmcloughlin
doc: link to sha1 directory
efb45b6 
Updates #13
mmcloughlin added a commit that referenced this issue Jan 7, 2019
@mmcloughlin
doc,examples/sum: improve doc on sum example
ff7d8af 
Updates #13
@mmcloughlin
Copy link
Owner Author

I think this looks okay now. @Willyham thoughts?

mmcloughlin added a commit that referenced this issue Jan 7, 2019
@mmcloughlin
doc: README tweaks
e18d405 
Thanks to @jsgoller1 

#13
mmcloughlin added a commit that referenced this issue Jan 7, 2019
@mmcloughlin
doc: tweak bullet point
f41ad5f 
#13
mmcloughlin added a commit that referenced this issue Jan 8, 2019
@mmcloughlin
doc: link to examples instead (#13)
0a3dff4
mmcloughlin added a commit that referenced this issue Jan 8, 2019
@mmcloughlin
doc: link to porting issue
ac9624a 
#13
mmcloughlin added a commit that referenced this issue Jan 8, 2019
@mmcloughlin
doc: extra credit
34d1536 
@dgryski 

#13
@mmcloughlin
Copy link
Owner Author

Let's see if people like it :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Initial Release
Development

No branches or pull requests
1 participant
@mmcloughlin