niolabs / docs Goto Github PK

http://docs.n.io/hardware/compute-install.md should have the installation process for MacOS and Windows documented under those sections.

• Add install prerequisites (brew, python3, wget, pip3, virtualenv)
  • ubuntu/debian prereqs: sudo apt-get install python3-dev python3-virtualenv
  • embedded (debian) prereqs: sudo apt-get install libffi-dev
  • windows pre-reqs should have links and directions to them. I might recommend using anaconda instead of pip, as things like numpy (which we might eventually support) are harder to install on windows (and anaconda solves that issue)
• modify nio install location. create virtual environment in ~/nio/versions/x.y.z
  • is this the place we are doing it? We aren't doing one venv per instance? I think all versions in ~/nio/versions is the best way to do things personally
  • are we not going to install nio through the CLI?
• install nio-cli
  • Is the plan just pip install https://github.com/neutralio/nio-cli/archive/master.zip or are we going to add the CLI to pypi?
• use cli to create project. create project in ~/nio/projects/pname
  • nio create ~/nio/projects/pname
• use cli to add blocks to project
  • something like

cd ~/nio/projects/pname
nio add util

• install block dependencies?!?! (we're going to go with requirements.txt file in block repos)
  • just standard requirements.txt? I think that is actually a good idea.
  • we need to update all repositories to have this.
  • is it going to automatically install all dependencies for all versions in ~/nio/versions? Only the latest version (unless you give a -v switch)? Ideas?
• "$" dollar signs in example bash code. should they be removed?
  • yes, I think so. Or you can get a markdown that displays them but they aren't copied (either way I think we would remove them in the text)
• run_nio needs to be run from root project directory
  • could we also have nio run to keep it consistent with the rest of the cli?

If you are using the Raspbian Stretch Lite image rather than the Desktop image (if you are thinking that a headless raspberry pi is a good idea). Then you'll need to explicitly get the ptyhon3-dev package to get the correct development headers in order to compile some of the dependencies of nio on an fresh install. Should this be added?