Wiki Todo
Mitch Bradley edited this page Apr 29, 2019
·
7 revisions
Need to update, validate, and expand the wiki.
To-do List:
- Check for consistency with the name "cnc", "cnc-js", "cncJS", "CNCjs". Needs to be just "cncjs"
- There is a broken link in the Docker section. Do we want to mention docker at all? How easy (or hard) is it to keep docker images up to date?
- Features List
-
- Explanation on Watch Directory's and what they do.
- [ ] Explanation of Configuration Options.
- Change wiki pages to conform to the new naming "cncjs-server" etc.
- Draw some pictures showing different scenarios - desktop app, server and client on same computer, server and client(s) separate
Documentation Issues
- Need a quick start guide for developers. There is a rudimentary development page with some tips, but it needs to be filled out and made comprehensive
- Explain what node.js and npm are, for the benefit of non-programmers
- https://github.com/cncjs/cncjs/wiki/Installation says "npm run prepublish" in two places. There is no prepublish target in the top-level package.json
General Notes & Refences
Join CNCjs Users Group on Facebook to share your experiences with other people.
Site: https://cnc.js.org
- Introduction
- Installation
- Using Pendants
-
Raspberry Pi Setup Guide
- System Setup & Preparation
- Install Node.js & CNCjs
- Install Node.js via Package Manager (Recommended)
- Install Node.js via Node Version Manager (NVM) (Alternative)
- Install Node.js Manually (Alternative)
- Use PM2 to auto-start CNCjs (Optional)
- Use Port 80 (Optional)
- Maintain
- Additional Setup Options:
- CNCjs UI on Pi - Adventures in PiLand
- Pi with Arduino Due
- Electron App
- User Guide
- Tool Change
- Troubleshooting
-
FAQ
- Forgot your password?
- How can I enable WebGL in my browser?
- Raspberry Pi: Error opening serial port "ttyAMA0"
- Webcam Streaming with Raspberry Pi
- Restream RTSP to M-JPEG
- Connect to an Arduino using WiFi
- Install Native Addons with Node.js v4
- Install Serialport on OS X El Capitan
- Kernel panic issue on macOS Sierra for devices using the CH340G, CH34G or CH34X chipset
- Testing without Arduino board
- Development
- API
- Wiki History
- Resources
- About