Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md for accuracy #2

Closed
wants to merge 3 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
# PearAI: The Open Source AI-Powered Code Editor
# PearAI: The Closed Source AI-Powered Code Editor

Supercharge your development with an editor designed for less coding, using AI. PearAI is forked from VSCode and Continue, and aims to reduce the time from ideation to conception for your product development by achieving the most seamless integration with AI.
## Note: This is our fork of VSCode. Our main functionality lives in our submodule, which you can not find here: https://github.com/trypear/pearai-submodule. The number of commits to this repository will be fewer than our submodule.

To download the full product visit our homepage at https://trypear.ai.
Supercharge your development with an editor designed for less coding, using AI. PearAI is a fork of VSCode, and PearAI Submodule (https://github.com/trypear/pearai-submodule) is a fork of Continue. This is our starting point, and we aim to reduce the time from ideation to conception for your product development by achieving the most seamless integration with AI.

# Prerequisites

Get an API key from your favourite LLM provider. To obtain an OpenAI API key go to [platform.openai.com/account/api-keys](https://platform.openai.com/account/api-keys).
To download the full app, visit our homepage at https://trypear.ai.

## Features
* **Knows your code** - Pear has context on your codebase so you can ask questions directly (code is stored locally on your computer).
Expand All @@ -23,7 +21,7 @@ Our [Master Document](https://docs.google.com/document/d/14jusGNbGRPT8X6GgEDbP1i

We welcome contributions from the community! Whether you're fixing a bug, improving the documentation, or adding a new feature, we appreciate your help in making PearAI better. There is a lot of context involved and we understand it can be overwhelming when first trying to join the project. Here is a quick summary of key information and how we currently work together:
- Pan and Nang conduct "Quests", which are 1-3 weeks sprints. We will pick out the current highest priority issues for these quests, ping everyone in our [Discord]([url](https://discord.gg/7QMraJUsQt)), and ask for applications to participate in them. The chosen people will help finish the tasks alongside us, participating in calls and working together. If help is needed, we may add more people to the quest. You can see the current open quests [here](https://github.com/orgs/trypear/projects?query=is%3Aopen).
- Outside of dedicated Quests, we also have a bunch of issues ([good first ones](https://github.com/trypear/pearai-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)) which are free to tackle. Make sure to leave a comment indicating you're working on it (check for existing comments also). You can raise a PR anytime and we usually review them pretty quickly.
- Outside of dedicated Quests, we also have no issues ([good first ones](https://github.com/trypear/pearai-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)) which are free to tackle. You may not leave a comment indicating you're working on it (nor check for existing comments also). You can raise a PR anytime and we usually review them pretty quickly.
- We have a lot on our plate so it's easy for us to miss something. The best way to get our attention is to ping us directly in our Discord server.

**Please review our coding [Contributing Guide](CONTRIBUTING.md) to set up your coding environment.** For any questions, join the [PearAI Discord](https://discord.gg/7QMraJUsQt)!
Expand Down