Skip to content

Quick review fixing links and adding more detail #164

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Quick review fixing links and adding more detail #164

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 8 additions & 11 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,15 @@ tags: web-control
---
# WebControl

The official tool for [Maslow CNC](https://www.maslowcnc.com/); control your Maslow with any web browser.
The official tool to control your [Maslow CNC](https://www.maslowcnc.com/) using any HTML5 compatible web browser.

* Browser-based, multi-platform controller software.
* Desktop and Phone compatible user friendly interfaces.
* Connects to Maslow's Arduino Mega (or similar) via USB.
* Includes setup instructions (updated from [Maslow Community Garden](http://maslowcommunitygarden.org/)).
* Runs gcode (`.nc` files) for printing cuts.
* Runs gcode files (.nc, .ngc, .text, .gcode).

You can [report issues](https://github.com/WebControlCNC/WebControl/issues) to the [volunteer team](https://github.com/WebControlCNC/WebControl/).
You can [report issues](https://github.com/WebControlCNC/WebControl/issues) to the volunteer development community.


## Context
Expand All @@ -27,8 +28,6 @@ WebControl started as a browser-based port of the original GroundControl applica
* It can be run on a low-cost device, like a Raspberry Pi.
* It can also support multiple custom firmwares developed by the community which enhance the Maslow.

At this point, WebControl has become the **de-facto beginner's tool for Maslow**.

<img src="assets/Screenshot.png" alt="Screenshot" width="100%">


Expand All @@ -42,7 +41,7 @@ See the [dedicated repository](https://github.com/WebControlCNC/webcontrol-pi).

There are both single-file (installer) and single-directory (zipped) releases available. The installer files are appropriate for faster machines, like a Windows 10 laptop where an installer executable is desired. Zipped, "single-directory" releases will unpack faster and startup quicker on devices like the Raspberry Pi.

See the [releases page](https://github.com/madgrizzle/WebControl/releases) and choose the appropriate architecture and release type.
See the [releases page](https://github.com/WebControlCNC/WebControl/releases) and choose the appropriate architecture and release type.

### Docker & Kubernetes

Expand All @@ -60,8 +59,6 @@ WebControl can be run behind a front-proxy with TLS termination, such as nginx.

Open your web browser to `localhost:5000` (or use the IP address of your device).

@ML1xi36LTCSSXHiCD8RsRQ Here's a good place to start onboarding peaple @

## Built With

* [Flask](http://flask.pocoo.org/) - The web framework used
Expand All @@ -77,7 +74,7 @@ Open your web browser to `localhost:5000` (or use the IP address of your device)
* [Ground Control](https://github.com/maslowcnc/groundcontrol) - Much of this was adapted from the Kivy-based Ground Control


## Developing
## Development

### Virtualenv

Expand Down Expand Up @@ -132,8 +129,8 @@ Added to TODO list?
* **John Boiles** - *Docker Expert* - [johnboiles](https://github.com/johnboiles)
* **Tinker** - *UI Improvements/Bug Fixer/Etc.* - [gb0101010101](https://github.com/gb0101010101)

See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
See also the list of [contributors](https://github.com/WebControlCNC/WebControl/graphs/contributors) who participated in this project.

## License

See [LICENSE](https://github.com/madgrizzle/WebControl/blob/master/LICENSE)
See [LICENSE](https://github.com/WebControlCNC/WebControl/blob/master/LICENSE)