77 lines
2.8 KiB
Markdown
77 lines
2.8 KiB
Markdown
|
# Fun with Binary
|
||
|
|
2018
|
||
|
|
|
||
|
|
(c) Diogo Cordeiro
|
||
|
|
|
||
|
|
This is the README file for Fun with Binary, an app to help introducing students how binary numbers work.
|
||
|
|
|
||
|
|
Further information about Fun with Binary can be found in the project home page:
|
||
|
|
|
||
|
|
[https://www.diogo.site/projects/fun_with_binary/](https://www.diogo.site/projects/fun_with_binary/)
|
||
|
|
|
||
|
|
## Getting Started
|
||
|
|
|
||
|
|
Fun with Binary is divided in three components, the Client, the Server, the Output.
|
||
|
|
|
||
|
|
### Prerequisites
|
||
|
|
|
||
|
|
### Server
|
||
|
|
|
||
|
|
For the server you need a webserver with PHP support (it can be localhost).
|
||
|
|
|
||
|
|
### Client
|
||
|
|
|
||
|
|
You can run it in the same server's webserver, although a ready to use live client was made avaiable in the folowing address:
|
||
|
|
|
||
|
|
```
|
||
|
|
http://diogo.site/projects/fun_with_binary/client/
|
||
|
|
```
|
||
|
|
|
||
|
|
Despite that, it might be interesting to convert it in an actual mobile app :)
|
||
|
|
|
||
|
|
### Output
|
||
|
|
|
||
|
|
For the Arduino based output you obviously need an arduino, 6 leds (from which three of them must be red and the other three of another color).
|
||
|
|
|
||
|
|
## Built With
|
||
|
|
|
||
|
|
* [Ratchet](https://github.com/twbs/ratchet) - The mobile targeted web framework used in the client
|
||
|
|
|
||
|
|
## Versioning
|
||
|
|
|
||
|
|
I use [SemVer](http://semver.org/) for versioning. For the versions available, see the tags on this repository.
|
||
|
|
|
||
|
|
## Authors
|
||
|
|
|
||
|
|
* **Diogo Cordeiro** - *Initial work* - [Fun with Binary](https://gitlab.com/up201705417/fun-with-binary)
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
This program is free software: you can redistribute it and/or modify
|
||
|
|
it under the terms of the GNU Affero General Public License as
|
||
|
|
published by the Free Software Foundation, either version 3 of the
|
||
|
|
License, or (at your option) any later version.
|
||
|
|
|
||
|
|
This program is distributed in the hope that it will be useful, but
|
||
|
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||
|
|
Affero General Public License for more details.
|
||
|
|
|
||
|
|
You should have received a copy of the GNU Affero General Public
|
||
|
|
License along with this program, in the file "COPYING". If not, see
|
||
|
|
<http://www.gnu.org/licenses/>.
|
||
|
|
|
||
|
|
IMPORTANT NOTE: The GNU Affero General Public License (AGPL) has
|
||
|
|
*different requirements* from the "regular" GPL. In particular, if
|
||
|
|
you make modifications to the Fun with Binary source code on your server,
|
||
|
|
you *MUST MAKE AVAILABLE* the modified version of the source code
|
||
|
|
to your users under the same license. This is a legal requirement
|
||
|
|
of using the software, and if you do not wish to share your
|
||
|
|
modifications, *YOU MAY NOT INSTALL FUN WITH BINARY*.
|
||
|
|
|
||
|
|
Additional library software has been made available (and were referenced
|
||
|
|
in the "Built With" section). All of it is Free Software and can be
|
||
|
|
distributed under liberal terms, but those terms may differ in detail
|
||
|
|
from the AGPL's particulars. See each package's license file in their
|
||
|
|
official repository for additional terms.
|