matrix-creator-quickstart icon indicating copy to clipboard operation
matrix-creator-quickstart copied to clipboard

The documentation is terrible

Open alejandrojapkin opened this issue 7 years ago • 1 comments

There are wiki entries that assume you've downloaded and are aware of other pieces of software that are never mentioned in the same wiki, there are instructions looping to other instructions over links that contradict each other, there are deb packages that may or may not overlap certain other compiled objects (impossible to know!) . There's the "getting started" which leads you to installing that CLI which eventually you find out, serves no purpose at this point but, hey!, you did spend time doing videos on that instead of covering the basics, like how to properly make the firmware work, and how to connect to each of the sensor component. This is not some "favor" you're doing your customers, if you release a hardware that is meant for the exact purpose of prototyping, then Documentation is a MUST, is not a kind gesture to your customers but your duty. I will copy and paste the response (or lack of it) here in well known forums; I purchased this product because I was in a hurry to create a prototype for which I could have asked acquaintances developing FPGAs; now my project is in serious danger because your board lacks the basic public knowledge-base for me to get on track with acceptable speed for someone who understands bash, python and C.

alejandrojapkin avatar Mar 29 '17 06:03 alejandrojapkin

Hi @datascienceteam01,

Sorry to here you are having issues, we're definitely here to help. The "Getting Started" leads you to work with Core Libraries or Upper-Level libraries depending on which route you take here: https://docs.matrix.one, which you can get to as well from https://creator.matrix.one.

If you need to look into how to set up the lower-level libraries, go here: https://matrix-io.github.io/matrix-documentation/MALOS/overview/

If you need examples, at the bottom of the above page, there is a link to examples: https://matrix-io.github.io/matrix-documentation/MALOS/example/

Additional Examples on Github: NodeJS: https://github.com/matrix-io/matrix-creator-malos/tree/master/src/js_test Python: https://github.com/matrix-io/matrix-creator-malos/tree/master/src/python_test

Note: All other integrations can occur through ZMQ similar to the way Python and NodeJS do.

If you want more in depth details on how MALOS works, you can go here: https://github.com/matrix-io/matrix-creator-malos

If you need any additional assistance whatsoever, or have any additional feedback please let us know. We are continuously working on our documentation and are working on covering the holes as you mentioned, so thank you for the feedback.

brianofrokk3r avatar Mar 29 '17 17:03 brianofrokk3r