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

Overhaul README with collapsible sections and add section discussing structs #12

Merged
merged 2 commits into from
Jan 8, 2020

Conversation

MasonProtter
Copy link
Contributor

The readme in its current form was a bit sprawling and hard to manage. I made sections of it collapsible so it is easier to navigate and get an overview. An alternative approach would be a table of contents.

I also added a section called "Dealing with structs" where I recommend StructArrays.jl for kernels involving unsupported number types and demo it with that gemm kernel I posted on discourse.

@codecov-io
Copy link

codecov-io commented Jan 8, 2020

Codecov Report

Merging #12 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #12   +/-   ##
=======================================
  Coverage   84.82%   84.82%           
=======================================
  Files          10       10           
  Lines        1285     1285           
=======================================
  Hits         1090     1090           
  Misses        195      195

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f55123e...4bdab4f. Read the comment docs.

@chriselrod chriselrod merged commit 2922c1b into JuliaSIMD:master Jan 8, 2020
@chriselrod
Copy link
Member

Thanks, this great!

I'll fix these typos on line 176, dealing with structs next time I make a commit:
"arrays conatining structs"
"currently reccomended that"

@MasonProtter
Copy link
Contributor Author

I'll fix these typos on line 176, dealing with structs next time I make a commit:
"arrays conatining structs"
"currently reccomended that"

Whoops, sorry about that.

This pull request was closed.
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.

3 participants