Skip to content

More README updates#4

Merged
gigasquid merged 1 commit intogigasquid:improve-clojure-readmefrom
kohr-h:more-clj-readme
Nov 2, 2018
Merged

More README updates#4
gigasquid merged 1 commit intogigasquid:improve-clojure-readmefrom
kohr-h:more-clj-readme

Conversation

@kohr-h
Copy link

@kohr-h kohr-h commented Nov 1, 2018

I have made some more edits, in particular the "Getting Involved" section that I've tried to flesh out a bit. Check if you like it -- since you have a better overview of how things work, you may want to change things accordingly.

@kohr-h kohr-h requested a review from gigasquid as a code owner November 1, 2018 23:45

## Getting Involved

By far the best way to get involved with this project is to install the Clojure MXNet package, run the examples, play around, build new things with it, and get back to the development team with feedback! Your input can not only help to identify current issues, but also guide the future development of the Clojure package by pointing out must-have features that are currently missing, or by identifying usability or performace problems of high impact.
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't sure if I should use "we" or "us".

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it sounds fine as is - but us also works


## Getting Involved

By far the best way to get involved with this project is to install the Clojure MXNet package, run the examples, play around, build new things with it, and get back to the development team with feedback! Your input can not only help to identify current issues, but also guide the future development of the Clojure package by pointing out must-have features that are currently missing, or by identifying usability or performace problems of high impact.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it sounds fine as is - but us also works

There are two main ways of reaching out to other users and the package maintainers:

- If you have a question or general feedback, or you encountered a problem but are not sure if it's a bug or a misunderstanding, then the *Apache Slack* (channels `#mxnet` and `#mxnet-scala`) is the best place to turn check out. To join, [ask for an invitation](https://mxnet.apache.org/community/contribute.html#slack) at `dev@mxnet.apache.org`.
- If you found a bug, miss an important feature or want to give feedback directly relevant for development, please head over to the MXNet [GitHub issue page](https://github.com/apache/incubator-mxnet/issues) and create a new issue. If the issue is specific to the Clojure package, consider using a title starting with `[Clojure]` to make it easily discoverable among the many other, mostly generic issues.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great point about the Clojure title 💯


## Getting Involved

By far the best way to get involved with this project is to install the Clojure MXNet package, run the examples, play around, build new things with it, and get back to the development team with feedback! Your input can not only help to identify current issues, but also guide the future development of the Clojure package by pointing out must-have features that are currently missing, or by identifying usability or performace problems of high impact.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is great!

Since there is native code involved in the framework, what OS you are running matters.

The following combinations of operating system and compute device are supported:
Since the core contains native (compiled) code and is bundled with the language bindings, your hardware and OS matter to the choices to be made during installation. The following combinations of operating system and compute device are supported:
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice wording

@gigasquid
Copy link
Owner

Looks great. Thanks tons for the improvements

@gigasquid gigasquid merged commit a85ac7a into gigasquid:improve-clojure-readme Nov 2, 2018
@kohr-h
Copy link
Author

kohr-h commented Nov 2, 2018

Cool, thanks for the quick reply!

@kohr-h kohr-h deleted the more-clj-readme branch November 2, 2018 16:21
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