Documentation

[tafia]

Is there any documentation?

• the link in the readme doesn't work
• when going on docs.rs, there is no comments, only function signatures

I've read the examples, there are parts I don't fully understand.

For instance, is this comment supposed to enlighten the reader about some functionality or has it been put here for debug purpose (I don't know what export does)?

    let cupi = CuPi::new().unwrap();
    let mut pinout = cupi.pin(0).unwrap().high().output();
    //let mut pin = cupi.pin_sys(0).unwrap();
    //pin.export().unwrap();
    //let mut pinout = pin.output().unwrap();

[inre]

Cupi has two GRIO mods. First, it's direct access to GPIO registers over shared memory (super fast) but root is required. Second, over linux GPIO and sysfs interface (any user). We need to export pin to userland. You can read about this approach here. Sorry for the lack of documentation.

[tafia]

Thanks! Do you want to keep the issue open just as a reminder to add more documentation? You can close it else.

[tinywombat765]

The link to the docs the readme should point to https://inre.github.io/cupi/cupi/index.html