|
1 | 1 | This repository is part of the [codebender.cc](http://www.codebender.cc) maker and artist web platform. |
2 | 2 |
|
3 | | -[](https://travis-ci.org/codebendercc/compiler) [](https://coveralls.io/r/codebendercc/compiler?branch=master) |
| 3 | +[](https://travis-ci.org/codebendercc/compiler) |
| 4 | +[](https://coveralls.io/r/codebendercc/compiler?branch=master) |
4 | 5 |
|
5 | 6 | ## And what's that? |
6 | 7 |
|
7 | | -codebender comes to fill the need for reliable and easy to use tools for makers. |
8 | | -A need that from our own experience could not be totally fulfilled by any of the existing solutions. Things like installing libraries, updating the software or installing the IDE can be quite a painful process. |
| 8 | +codebender fills the need for reliable, easy to use tools for makers, a need that couldn't be completely fulfilled by any existing solution according to our experience. |
9 | 9 |
|
10 | | -In addition to the above, the limited features provided (e.g. insufficient highlighting, indentation and autocompletion) got us starting building codebender, a completely web-based IDE, that requires virtually no installation and offers a great code editor. It also stores your sketches on the cloud. |
| 10 | +Things like installing libraries or the IDE and updating software sometimes were (and still are) quite a painful process. But in addition to the above, the limited features provided (e.g. insufficient highlighting, indentation and autocompletion) got us to start codebender, a completely web-based IDE that requires virtually no installation and offers a great code editor. Plus it stores your sketches on the cloud. Yeah! |
11 | 11 |
|
12 | | -That way, you can still access your sketches safely even if your laptop is stolen or your hard drive fails! codebender also takes care of compilation, giving you extremely descriptive warnings on terrible code. On top of that, when you are done, you can upload your code to your Arduino straight from the browser. |
| 12 | +With your code on the cloud, you can access your sketches safely even if your laptop is stolen or your hard drive fails! codebender also compiles your code giving you extremely descriptive error descriptions on terrible code. There's even more, you can upload your code to your Arduino straight from the browser. |
13 | 13 |
|
14 | 14 | ## How does the compiler come into the picture? |
15 | 15 |
|
16 | | -The compiler repository includes all the necessary files needed to run the compiler as a service. It receives the code as input and outputs the errors in the code, or the compiled output if the compilation was successful. We provide a really easy to use interface to allow us to send the code to the compiler easily. |
| 16 | +The compiler repository includes all the necessary files needed to run the compiler as a service. It receives the code as input and outputs the compiled output if the compilation was successful or the errors present in the code. We provide an easy interface to send the code to the compiler. |
17 | 17 |
|
18 | 18 | Here's a list of open source projects we use |
19 | 19 | * Clang |
20 | 20 | * gcc-avr |
21 | 21 | * avr binutils (avrsize) |
22 | 22 |
|
23 | | -For development, we've used it on a variety of Linux and Mac OS X machines. |
| 23 | +For development we've run it on a variety of Linux and Mac OS X machines. |
24 | 24 |
|
25 | | -For production, we are using Ubuntu Server 12.04, and we know it works perfectly with that, so we suggest using that as well. |
| 25 | +For production we are using Ubuntu Server 12.04. We know the compiler works perfectly on it, so we suggest you using it as well. |
| 26 | + |
| 27 | +## How to install |
| 28 | + |
| 29 | +Check out the code in any directory you wish |
| 30 | + |
| 31 | +`git clone https://github.com/codebendercc/compiler.git` |
| 32 | + |
| 33 | +Then cd in the created directory (if you run the command as is above, it would be named `compiler`) and run |
| 34 | + |
| 35 | +`scripts/install.sh` |
| 36 | + |
| 37 | +(don't cd into scripts directory and run install.sh from there, it won't work) |
| 38 | + |
| 39 | +If you now visit `http://localhost/status` you'll see a JSON response telling you everything's ok: |
| 40 | +`{"success":true,"status":"OK"}` |
| 41 | + |
| 42 | +## What's next? |
| 43 | + |
| 44 | +Visit the [wiki](https://github.com/codebendercc/compiler/wiki) for more information. |
| 45 | + |
| 46 | +## How can someone contribute? |
| 47 | + |
| 48 | +Contribution is always welcome whether it is by creating an issue for a bug or suggestion you can't fix yourself or a pull request for something you can. |
| 49 | + |
| 50 | +If you write new code or edit old code please don't forget to add/update relative unit tests that come with it. It is always a good idea to run tests localy to make sure nothing breaks before you create a pull request. |
| 51 | + |
| 52 | +We expect new code to be [PSR-2](http://www.php-fig.org/psr/psr-2/) but we know we carry legacy code with different coding styles. You're welcome to fix that. |
0 commit comments