Skip to content

Commit 31c47ec

Browse files
authored
Merge pull request #66 from Lemoncode/#60-create-readme
#60-create-new-readme
2 parents 5da6a89 + 6f4d74d commit 31c47ec

2 files changed

Lines changed: 77 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 77 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,77 @@
1-
# code-paster
1+
<!-- PROJECT SHIELDS -->
2+
<!--
3+
*** I'm using markdown "reference style" links for readability.
4+
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
5+
*** See the bottom of this document for the declaration of the reference variables
6+
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
7+
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
8+
-->
9+
10+
[![Contributors][contributors-shield]][contributors-url]
11+
[![Forks][forks-shield]][forks-url]
12+
[![Stargazers][stars-shield]][stars-url]
13+
[![Issues][issues-shield]][issues-url]
14+
[![MIT License][license-shield]][license-url]
15+
16+
<!-- PROJECT LOGO -->
17+
<br />
18+
<p align="center">
19+
<a href="https://github.com/Lemoncode/code-paster">
20+
<img src="images/logo.png" alt="Logo" width="800" height="330">
21+
</a>
22+
<p align="center">
23+
Code Paster is a Teacher-to-Student communication tool for online programming lessons. Create a new session and easily share your code with all students connected so they can follow along with your examples.
24+
</p>
25+
</p>
26+
<br />
27+
28+
<!-- TABLE OF CONTENTS -->
29+
30+
## Table of Contents
31+
32+
- [About the Project](#about-the-project)
33+
- [Built With](#built-with)
34+
- [Roadmap](#roadmap)
35+
- [License](#license)
36+
37+
<!-- ABOUT THE PROJECT -->
38+
39+
## About The Project
40+
41+
During your programming online lessons you will write hundreds of lines of code and dozens of snippets. For students following along with the code there's nothing more annoying than falling behind the explanation because of a small typo or a missed variable. With Code Paster you can simply copy your code examples and share it in real time with your classroom.
42+
43+
This project was developed by Lemoncode Frontend Master students:
44+
45+
<!-- Include collaborators -->
46+
47+
### Built With
48+
49+
- [React](https://github.com/facebook/react/)
50+
- [Material-UI](https://material-ui.com/)
51+
- [Socket.io](https://socket.io/)
52+
53+
<!-- ROADMAP -->
54+
55+
## Roadmap
56+
57+
See the [open issues](https://github.com/Lemoncode/code-paster/issues) for a list of proposed features (and known issues).
58+
59+
<!-- LICENSE -->
60+
61+
## License
62+
63+
Distributed under the MIT License. See `LICENSE` for more information.
64+
65+
<!-- MARKDOWN LINKS & IMAGES -->
66+
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
67+
68+
[contributors-shield]: https://img.shields.io/github/contributors/Lemoncode/code-paster.svg?style=flat-square
69+
[contributors-url]: https://github.com/Lemoncode/code-paster/graphs/contributors
70+
[forks-shield]: https://img.shields.io/github/forks/Lemoncode/code-paster.svg?style=flat-square
71+
[forks-url]: https://github.com/Lemoncode/code-paster/network/members
72+
[stars-shield]: https://img.shields.io/github/stars/Lemoncode/code-paster.svg?style=flat-square
73+
[stars-url]: https://github.com/Lemoncode/code-paster/stargazers
74+
[issues-shield]: https://img.shields.io/github/issues/Lemoncode/code-paster.svg?style=flat-square
75+
[issues-url]: https://github.com/Lemoncode/code-paster/issues
76+
[license-shield]: https://img.shields.io/github/license/Lemoncode/code-paster.svg?style=flat-square
77+
[license-url]: https://github.com/Lemoncode/code-paster/blob/master/LICENSE.txt

‎images/logo.png‎

48.8 KB
Loading

0 commit comments

Comments
 (0)