From 50c8525e76f5c55b098aea3ab78289594acea0fe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Fejoz?= Date: Tue, 12 Sep 2017 21:20:52 +0200 Subject: [PATCH] chore: first documentation draft --- LICENSE | 2 +- README.md | 39 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 40 insertions(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index 94ffb40..da6a18d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2017 NYBI +Copyright (c) 2017 NYBI.cc Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index ee55202..6302def 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,41 @@ # web-gcode-tools + Online G-Code edition tools + +## Description + +Online tools to ease modification/adjustement of G-Code for 3D printers +and CNC. + +## System Requirements + +A browser with Javascript activated. + +## Contribute + +If you would like to hack on web-gcode-tools, start by forking the repo on GitHub: + +https://github.com/NYBI/web-gcode-tools + +The best way to contribute is probably one of the following: + +* Clone the repo and follow [GitHub + Workflow](https://guides.github.com/introduction/flow/index.html). +* Contact us on [twitter](https://twitter.com/nybicc) or [Facebook](https://www.facebook.com/NYBI.CC/) +* [Visit us](http://nybi.cc/nous-contacter/) + +See our [Roadmap](https://github.com/NYBI/web-gcode-tools/projects/1) and [all issues](https://github.com/loic-fejoz/kirigamixel/issues) + + +Changes +---------- + +TO BE DONE + +Authors +------- + +This is a list of people who have contributed code or ideas to web-gcode-tools -- +for copyright purposes or whatever. + +* Loïc Fejoz