diff --git a/LICENSE b/LICENSE.md similarity index 100% rename from LICENSE rename to LICENSE.md diff --git a/README.md b/README.md index d03548d..d2fe285 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,35 @@ -# Teach GPT -Teach GPT πŸ€– is a groundbreaking open-source initiative focused on developing an AI-Powered Virtual Tutor. This innovative virtual tutor leverages the full potential of artificial intelligence to revolutionize the way we learn. The primary objective is to construct a Large Language Model(LLM) that dynamically adjusts to individual learning styles while delivering lifelike conversations through AI agents. This is complemented by seamless integration of speech recognition technology and the strategic incorporation of gamification methods πŸ‘©πŸ»β€πŸ’» . \ No newline at end of file +
+# TeachGPTπŸ€– +TeachGPT is a groundbreaking open-source initiative focused on developing an AI-Powered Virtual Tutor. This innovative virtual tutor leverages the full potential of artificial intelligence to revolutionize the way we learn. The primary objective is to construct a Large Language Model(LLM) that dynamically adjusts to individual learning styles while delivering lifelike conversations through AI agents. This is complemented by seamless integration of speech recognition technology and the strategic incorporation of gamification methods πŸ‘©πŸ»β€πŸ’» . +
+ +## We are on Hacktoberfest 2023! πŸš€πŸŽ‰ + + +## Installation πŸ› οΈ + +To get started with TeachGPT, follow these steps: + +1. Clone the repository: `git clone https://github.com/Priyamakeshwari/TeachGPT.git` +2. Navigate to the project directory: `cd TeachGPT` + +## Contributing πŸ‘₯ + +Contributions are welcome! If you have a dataset that you would like to add to DataStorehouse, please follow these steps: + +1. Fork the TeachGPT repository to your own GitHub account. +2. Clone the forked repository to your local machine. +3. Create a new branch for your changes: `git checkout -b feature-name`. +4. Implement your changes and commit them with meaningful commit messages. +5. Push your changes to your forked repository. +6. Create a pull request (PR) to the main NeoGPT repository, describing your changes and the problem they solve. + +Our team will review your PR, provide feedback, and merge it if it meets our guidelines. + +If your changes include new functionality or modifications, please write appropriate unit tests to ensure that the code works as expected. Run the existing tests to ensure that your changes do not introduce regressions. + + +## License πŸ“ + +TeachGPT is released under the [MIT License](./LICENSE.md). πŸ“„ + diff --git a/readme.png b/readme.png new file mode 100644 index 0000000..e6e5e09 Binary files /dev/null and b/readme.png differ