Skip to content

Commit 1141212

Browse files
committed
Add images and documentation
1 parent 980861a commit 1141212

26 files changed

+205
-3
lines changed

README.md

Lines changed: 84 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,90 @@
1717

1818
# Codeium for Visual Studio
1919

20-
_Free, ultrafast Copilot alternative for Visual Studio_
20+
[Codeium](https://codeium.com/) is the modern coding superpower, a free code acceleration toolkit built on cutting edge AI technology. Currently, Codeium provides autocomplete, chat, and search capabilities in 70+ languages, with lightning fast speeds and state-of-the-art suggestion quality.
2121

22-
Codeium autocompletes your code with AI in all major IDEs. Check out our [playground](https://www.codeium.com/playground) if you want to quickly try out Codeium online.
22+
There are many parts of the modern coding workflow that are boring, tedious, or frustrating, from regurgitating boilerplate to poring through StackOverflow. Recent advances in AI allow us to eliminate these parts, making it seamless to turn your ideas into code. With easy integration into Visual Studio and a less than 2 minute installation process, you can focus on being the best software developer, not the best code monkey.
2323

24-
Contributions are welcome! Feel free to submit pull requests and issues related to the plugin.
24+
With Codeium, you get:
25+
- Unlimited single and multi-line code completions forever.
26+
- IDE-integrated chat: no need to leave Visual Studio to ChatGPT, and use convenient suggestions such as [Refactor](#refactor) and [Explain](#explain).
27+
- Support for 70+ programming languages: Javascript, Python, Typescript, PHP, Go, Java, C, C++, Rust, Ruby, and more.
28+
- Support through our [Discord Community](https://discord.gg/3XFf78nAx5).
2529

30+
Join thousands of other developers who are using Codeium for free to accelerate their software iteration process, improve their code quality and consistency, reduce the number of code review iterations, accelerate developer onboarding, and keep them in their flow state. Want to learn more? Check out our [FAQ](https://codeium.com/faq).
31+
32+
Check out our [playground](https://www.codeium.com/playground) if you want to quickly try out Codeium online.
33+
34+
# Your New Autocomplete Superpowers
35+
## Use Natural Language
36+
37+
Need to make changes in an unfamiliar language or codebase? Instead of spending hours learning all of the syntactical and stylistic details, type out comments in natural language and let Codeium get the job done.
38+
39+
<p align="center">
40+
<image src="docs/images/gen_random.gif" width="500"/>
41+
</p>
42+
43+
## Minimize Boilerplate Coding
44+
45+
Sometimes feel like a code monkey copy-pasting and modifying boilerplate code over and over again? Let Codeium handle writing the repetitive work so that you can stay in the coding flow state, generating code faster than you can type.
46+
47+
<p align="center">
48+
<image src="docs/images/auto_complete.gif" width="500"/>
49+
</p>
50+
51+
# Your New Chat Superpowers
52+
## Generate
53+
54+
Codeium Chat can generate whole functions and applications for you with simple natural language prompting and constraints.
55+
56+
<p align="center">
57+
<image src="docs/images/chat_generate_function.gif" width="800"/>
58+
</p>
59+
60+
## Explain
61+
62+
Diving into a foreign codebase? With the push of a button, our assistant will explain everything you need to know.
63+
64+
<p align="center">
65+
<image src="docs/images/chat_explain.gif" width="800"/>
66+
</p>
67+
68+
## Refactor
69+
70+
Want to rewrite your existing code to add a new feature? Fix a bug? Make it prettier? Click a button and tell your Codeium assistant what you want.
71+
72+
<p align="center">
73+
<image src="docs/images/chat_refactor.gif" width="800"/>
74+
</p>
75+
76+
## Translate
77+
78+
Leverage the power of AI to translate whole functions from one language to another within seconds.
79+
80+
<p align="center">
81+
<image src="docs/images/chat_convert.gif" width="800"/>
82+
</p>
83+
84+
## Explain Problem
85+
86+
Ever feels like warnings and errors are too verbose? Codeium can explain like you're five!
87+
<p align="center">
88+
<image src="docs/images/chat_explain_problem.gif" width="800"/>
89+
</p>
90+
91+
# Build Instructions
92+
- Open Visual Studio Installer and click the Modify button. Install the "Visual Studio extension development" in Other Toolsets.
93+
- Install the [Extensibility Essentials 2022](https://marketplace.visualstudio.com/items?itemName=MadsKristensen.ExtensibilityEssentials2022) extension.
94+
- Open `Codeium.sln` and press <kbd>CTRL+B</kbd> to build, if there were no errors, there should be a `Codeium.vsix` file in the `CodeiumVS/bin` folder.
95+
- You can press <kbd>F5</kbd> to debug the extension on a separate instance of Visual Studio. Consult the [official guide](https://learn.microsoft.com/en-us/visualstudio/extensibility/starting-to-develop-visual-studio-extensions?view=vs-2022) for more information.
96+
97+
# How to help
98+
Feel free to [submit issues](https://github.com/Exafunction/CodeiumVisualStudio/issues/new) related to the extension so that we can better improve your experiences.
99+
100+
We greatly value your input and invite you to contribute to our project. To do so, kindly [initiate a pull request](https://github.com/Exafunction/CodeiumVisualStudio/compare). Your expertise and insights are much appreciated.
101+
102+
# Documentation
103+
For more information on how to install and use the extension, please see [the documentation](/docs/).
104+
105+
# License
106+
Codeium Extension for Visual Studio is licensed under the MIT License, see [LICENSE.txt](/LICENSE.txt) for more information.

docs/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Table of contents
2+
1. [Installing Codeium Extension for Visual Studio](installing.md)
3+
2. [Using the Extension](using.md)

docs/images/auto_complete.gif

1.34 MB
Loading

docs/images/chat_convert.gif

3.1 MB
Loading

docs/images/chat_explain.gif

3.62 MB
Loading
2.54 MB
Loading
3.42 MB
Loading

docs/images/chat_refactor.gif

4.72 MB
Loading

docs/images/gen_random.GIF

942 KB
Loading

docs/images/installation_1.png

2.82 KB
Loading

0 commit comments

Comments
 (0)