This repository has been archived by the owner on Nov 16, 2023. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Mehdi Chaid
committed
Apr 26, 2018
1 parent
19e3353
commit dd90f6c
Showing
208 changed files
with
35,361 additions
and
72 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Installation | ||
|
||
## Requirements | ||
|
||
* Windows 10 | ||
* .Net Framework | ||
* WPF libraries | ||
|
||
## Installation process | ||
|
||
You can fork the project in the github repository of [SnipAI](https://github.com). | ||
|
||
Then navigate to the code location on your Windows 10 machine and double click the solution file `SnipInsight.sln`. | ||
|
||
From there, select the C# project file `SnipInsight.csproj`. You should now be able to build and run the solution. | ||
|
||
The next step to test the AI features is to generate API keys for each AI service. Read our [guide](https://github.com) to learn how to generate API keys and then paste them in the settings panel. | ||
|
||
Congratulations! You should now have a fully working application to get started. Have fun testing the project and thank you for your contribution! | ||
|
||
## Troubleshooting | ||
|
||
> No project is selected for compilation | ||
Make sure you have selected the Debug configuration and are building the project correctly. | ||
|
||
> I can't run the project | ||
You are most likely missing libraries. Right click on the SnipInsight project and select *Install missing packages* if that option is available. | ||
|
||
> I don't see the fields to paste my API keys on the settings panel | ||
That is because you have not yet enabled AI assistance. Please enable it first and then enter your API keys. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
<?xml version="1.0" encoding="utf-8"?> | ||
<configuration> | ||
<packageSources> | ||
<add key="NuGet.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" /> | ||
</packageSources> | ||
</configuration> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,20 @@ | ||
#Introduction | ||
TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project. | ||
|
||
# Contributing | ||
#Getting Started | ||
TODO: Guide users through getting your code up and running on their own system. In this section you can talk about: | ||
1. Installation process | ||
2. Software dependencies | ||
3. Latest releases | ||
4. API references | ||
|
||
This project welcomes contributions and suggestions. Most contributions require you to agree to a | ||
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us | ||
the rights to use your contribution. For details, visit https://cla.microsoft.com. | ||
#Build and Test | ||
TODO: Describe and show how to build your code and run the tests. | ||
|
||
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide | ||
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions | ||
provided by the bot. You will only need to do this once across all repos using our CLA. | ||
#Contribute | ||
TODO: Explain how other users and developers can contribute to make your code better. | ||
|
||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or | ||
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. | ||
If you want to learn more about creating good readme files then refer the following [guidelines](https://www.visualstudio.com/en-us/docs/git/create-a-readme). You can also seek inspiration from the below readme files: | ||
- [ASP.NET Core](https://github.com/aspnet/Home) | ||
- [Visual Studio Code](https://github.com/Microsoft/vscode) | ||
- [Chakra Core](https://github.com/Microsoft/ChakraCore) |
Oops, something went wrong.