Skip to content

Conversation

@mlloreda
Copy link
Member

  • Reorganized structure of the document. Most notably, the example code has
    been pulled near the top and the contact section has been pushed to the bottom
    of the document.
  • Citation information has been moved to a new file, CITATION.md. ArrayFire
    is probably not cited enough to warrant a spot in the README.
  • Removed techical@arrayfire.com email address. Users should use the issue
    tracker or the Google Groups mailing list, instead.
  • Example code now using two-space indentation.

@mlloreda
Copy link
Member Author

mlloreda commented Mar 1, 2016

After some discussion, a task list was created to further improve the README:

  • Move CITATIONS.md to .github/
  • Link to CITATIONS.md from README.md and bring back sentence about acknowledgements
  • Remove cruft from current code example
  • Attempt to simplify current code example
  • Include another example - currently a stripped-out version of fractal.cpp conway.cpp
  • Differentiate between official and unofficial install methods
  • Make the README feel less empty
  • Blow away broken code coverage badge
  • Show output of one iteration of fractal.cpp
  • Create GIF of fractal.cpp example and add to README.md

@mlloreda
Copy link
Member Author

@pavanky

* Reorganized structure of the document. Most notably, the example code
has been pulled near the top and the contact section has been pushed to the
bottom of the document.
* `Hello, world` example has been stripped down
* Added a new example, featuring a stripped version of `conway.cpp`
* Conway GIF
* Citation information has been moved to new location, `.github/CITATION.md`
* Link to `forge` in introductory paragraph
* New 'Language Wrapper' section
* Removed `techical@arrayfire.com` email address. Users should use the
issue tracker or the Google Groups mailing list, instead.
* Example code now using two-space indentation.
pavanky added a commit that referenced this pull request Mar 15, 2016
@pavanky pavanky merged commit 927987f into arrayfire:hotfix-3.3.1 Mar 15, 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.

2 participants