diff --git a/FOSS 1 .webm b/FOSS 1 .webm new file mode 100644 index 00000000..e4133e5f Binary files /dev/null and b/FOSS 1 .webm differ diff --git a/README.md b/README.md index 16b68fe5..591ffff1 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,67 @@ -# CoderType -This is a silly typing game I made as an experiment to see -how much can chatGPT help me in coding. +# Coder-Type -Run locally using: `yarn parcel index.html` +The code speed typing game you have been looking for. Mainly its a part of video content about "How much chatGPT can help in coding" -# License -The code for the game itself is licensed under MIT. But the code snippets used in `scripts/data` are licensed as the corresponding open source repositories they are taken from. + + +## Demo +[FOSS 1 .webm](https://user-images.githubusercontent.com/102357739/226584755-331c2e89-7d49-4156-a0f8-3bada05fd572.webm) + +## Run it in your Local Machine + +First of all clone the Repo on your development + +### For Windows +```bash + git clone https://github.com/Markonis/coder-type.git +``` +### For Mac and Linux +```bash + sudo git clone https://github.com/Markonis/coder-type.git +``` +### Now go to the directory +```bash + cd coder-typer +``` +### Run the code +```bash + yarn parcel index.html +``` +## Featuers of this particular application + +- Helps ReactJS developers to practice real codes and decrease development time and improves typing speed +- Helps Every Linux user as well +- Helps Python Tensorflow users +- Very Developer friendly UI +- FOSS software + + + + +## Contributors + +- [@Marko](https://github.com/Markonis) +- [@cleverhare](https://www.github.com/cleverhare) +- [@lucaspalves](https://www.github.com/lucaspalves) +- [@rafaelcanoguitton](https://www.github.com/rafaelcanoguitton) +- [@thomashillen](https://www.github.com/thomashillen) +- [@BharathxD](https://www.github.com/BharathxD) + + +## Contributing + +Contributions are always welcome! + +To contribute in the specific Open Source software, Do raise an [issue](https://github.com/Markonis/coder-type/issues) firstly + +And if that issue is found to add any value to the project, Then it will be assigned to you. + + + + +## Thank You + +Thank you so much for making this till the very end. +