Update readme and add files (#3)

* Update readme and add files

* Remove copyrights

Author: Cristian González

CONTRIBUTING.md

@@ -0,0 +1,64 @@
+# Contributing to UNCode
+We love your input! We want to make contributing to this project as easy and 
+transparent as possible, whether it's:
+
+- Reporting a bug.
+- Discussing the current state of the code.
+- Submitting a fix.
+- Proposing new features
+
+## Our Development Process
+
+We use github to host code, to track issues and feature requests, as well 
+as accept pull requests.
+
+## Your First Contribution
+
+Unsure where to begin contributing to UNCode? You can start by looking through these beginner issues:
+**Good first issue** - issues which should only require a few lines of code and a not big understanding of UNCode.
+
+Working on your first Pull Request? You can learn how from this *free* series, 
+[How to Contribute to an Open Source Project on GitHub][contribute_github_url].
+
+## Pull Requests
+
+Pull requests are the best way to propose changes to the codebase 
+(we use [Github Flow][github_flow_url]. 
+
+We actively welcome your pull requests.
+
+1. Fork the repo (in case not an admin) and create your branch from `master`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite passes.
+5. Be sure you have followed the code style for the project.
+6. If you haven't already, complete the Contributor License Agreement ("CLA"). Note the code of conduct.
+7. Create the pull request to `master` branch.
+
+### Code review
+
+UNCode team will check your pull request and one of us will be assigned to review it and
+leave feedback. Make to reply the given feedback ASAP.
+
+## Contributor License Agreement ("CLA")
+In order to accept your pull request, you will need to sign the Contributor License Agreement.
+Once the PR is created, you will be told whether or not you need to sign it and how to do it.
+
+## Issues
+We use GitHub issues to track public bugs or Feature Requests. Please ensure your description is
+clear and has sufficient instructions to be able to reproduce the issue.
+
+## License
+In short, when you submit code changes, your submissions are understood to be under the 
+same [GNU][license_url] that covers the project. 
+Feel free to contact the maintainers if that's a concern.
+
+## Community
+
+Chat with us on [Gitter][gitter_url]. 
+We will reply for sure on weekdays at GMT-5 time.
+
+[contribute_github_url]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
+[github_flow_url]: https://guides.github.com/introduction/flow/index.html
+[license_url]: https://github.com/JuezUN/opt-cpp-backend/blob/master/LICENSE
+[gitter_url]: https://gitter.im/uncode-unal/community

README.md

@@ -1,15 +1,60 @@
-# opt-cpp-backend
+# UNCode - Online Python Tutor - C/C++ backend
 
-This is the repo for the C/C++ backend for Online Python Tutor (http://pythontutor.com/)
+[![License](https://img.shields.io/github/license/JuezUN/opt-cpp-backend?style=plastic)][license_url]
+[![Gitter](https://badges.gitter.im/uncode-unal/community.svg)][gitter_url]
+[![CLA assistant](https://cla-assistant.io/readme/badge/JuezUN/opt-cpp-backend)][cla_url]
+[![Contributors](https://img.shields.io/github/contributors/JuezUN/opt-cpp-backend?style=plastic)][contributors_url]
 
-Deployed online at:
+This is the repository for the C/C++ backend for [Online Python Tutor][python_tutor_repo_url]. We have forked this
+ repository to add some necessary modifications for our purposes, and correctly provide the python tutor service.
+ 
+The code of this repository is built using Docker stored in docker hub: [unjudge/opt-cpp-backend][unjudge/opt-cpp-backend],
+ which at the same time is used by a linux service called *cokapi*, see how we deploy this service [cokapi service][cokapi_url],
+ also see how Python tutor uses this deployed service in <https://github.com/JuezUN/OnlinePythonTutor/tree/master/v4-cokapi>.
+ The cokapi service is currently deployed in the port `4000`.
 
-- http://pythontutor.com/visualize.html#py=c (for C)
-- http://pythontutor.com/visualize.html#py=cpp (for C++)
+## Built with
 
-This code is based on a hacked version of Valgrind 3.11.0, downloaded from:
-http://www.valgrind.org/downloads/valgrind-3.11.0.tar.bz2
-
-Build dependencies:
+- C
 - (basic Linux C compiler toolchain)
 - binutils-dev
+- This code is based on a hacked version of Valgrind 3.11.0, downloaded from: <http://www.valgrind.org/downloads/valgrind-3.11.0.tar.bz2>
+
+## Documentation
+
+For additional documentation, please refer to the [Wiki][uncode_wiki_url].
+
+## Roadmap
+
+See the [UNCode GitHub Project][project_url] for a list of proposed features, known issues and how they are being 
+tackled.
+
+## Contributing
+
+Go to [CONTRIBUTING][contributing_url] to see the guidelines and how to start contributing to UNCode.
+
+## License
+
+Distributed under the GNU License. See [LICENSE][license_url] for more information.
+
+## Contact
+
+In case of technical questions, please use the [gitter communication channel][gitter_url].
+
+In case you want to host your course on our deployment, email us on: <uncode_fibog@unal.edu.co>
+
+UNCode: <https://uncode.unal.edu.co>
+
+Project page: <https://juezun.github.io/UNCode_page/>
+
+
+[license_url]: https://github.com/JuezUN/opt-cpp-backend/blob/master/LICENSE
+[contributing_url]: https://github.com/JuezUN/opt-cpp-backend/blob/master/CONTRIBUTING.md
+[project_url]: https://github.com/orgs/JuezUN/projects/3
+[python_tutor_repo_url]: https://github.com/JuezUN/OnlinePythonTutor
+[uncode_wiki_url]: https://github.com/JuezUN/INGInious/wiki
+[gitter_url]:https://gitter.im/uncode-unal/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
+[cla_url]: https://cla-assistant.io/JuezUN/opt-cpp-backend
+[contributors_url]: https://github.com/JuezUN/opt=cpp-backend/graphs/contributors
+[unjudge/opt-cpp-backend]: https://hub.docker.com/r/unjudge/opt-cpp-backend
+[cokapi_url]: https://github.com/JuezUN/Deployment/blob/master/deployment_scripts/deploy_cokapi_service.sh