Skip to content

Commit

Permalink
chore: first documentation draft
Browse files Browse the repository at this point in the history
  • Loading branch information
loic-fejoz committed Sep 12, 2017
1 parent 74f14ba commit 50c8525
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 1 deletion.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -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
Expand Down
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <[email protected]> <https://github.com/loic-fejoz/>

0 comments on commit 50c8525

Please sign in to comment.