Skip to content
This repository has been archived by the owner on Nov 16, 2023. It is now read-only.

Commit

Permalink
Initial OSS Release
Browse files Browse the repository at this point in the history
  • Loading branch information
Mehdi Chaid committed Apr 26, 2018
1 parent 19e3353 commit dd90f6c
Show file tree
Hide file tree
Showing 208 changed files with 35,361 additions and 72 deletions.
146 changes: 84 additions & 62 deletions .gitignore
@@ -1,7 +1,64 @@
################################################################################
# This .gitignore file was automatically created by Microsoft(R) Visual Studio.
################################################################################
# Do not use Notepad to edit this. Use VS, vim, Notepad++, etc. Uses UNIX line endings.

*.cache
*.nuget.props
*.nuget.targets
*.user
*.suo
*.sdf
*.opensdf
*.nupkg
*.opendb
*.VC.db

project.lock.json
[Oo]bj/
[Bb]in/
Debug/
Release/
Testing/
x86/
x64/
ARM/
ipch/
AppPackages/
.vs/
/Loc/Generated/
LocalizeApp.log
Generated Files/
/src/packages/


#Localized strings
/src/SoundRecorder/Resources/*
!/src/SoundRecorder/Resources/en-us
/src/SoundRecorder/BundleArtifacts/*
!lib/**/*

# Fortran module files
*.mod
*.smod

# Compiled Static libraries
*.lai
*.la
*.a
*.lib

# Executables
*.exe
*.out
*.app

# Visual Studio Files
.vs/


## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.
##
## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore

# User-specific files
*.suo
Expand All @@ -12,17 +69,20 @@
# User-specific files (MonoDevelop/Xamarin Studio)
*.userprefs

# Debug-only configuration settings
.conf

# Build results
[Dd]ebug/
[Dd]ebugPublic/
[Rr]elease/
[Rr]eleases/
x64/
x86/
[Xx]64/
[Xx]86/
[Bb]uild/
bld/
[Bb]in/
[Oo]bj/
[Ll]og/

# Visual Studio 2015 cache/options directory
.vs/
Expand All @@ -42,11 +102,9 @@ TestResult.xml
[Rr]eleasePS/
dlldata.c

# .NET Core
# DNX
project.lock.json
project.fragment.lock.json
artifacts/
**/Properties/launchSettings.json

*_i.c
*_p.c
Expand Down Expand Up @@ -85,7 +143,6 @@ ipch/
*.sdf
*.cachefile
*.VC.db
*.VC.VC.opendb

# Visual Studio profiler
*.psess
Expand Down Expand Up @@ -113,10 +170,6 @@ _TeamCity*
# DotCover is a Code Coverage Tool
*.dotCover

# Visual Studio code coverage results
*.coverage
*.coveragexml

# NCrunch
_NCrunch_*
.*crunch*.local.xml
Expand Down Expand Up @@ -148,15 +201,12 @@ publish/
# Publish Web Output
*.[Pp]ublish.xml
*.azurePubxml
# TODO: Comment the next line if you want to checkin your web deploy settings
# but database connection strings (with potential passwords) will be unencrypted
*.pubxml
*.publishproj

# Microsoft Azure Web App publish settings. Comment the next line if you want to
# checkin your Azure Web App publish settings, but sensitive information contained
# in these scripts will be unencrypted
PublishScripts/
# TODO: Un-comment the next line if you do not want to checkin
# your web deploy settings because they may include unencrypted
# passwords
#*.pubxml
*.publishproj

# NuGet Packages
*.nupkg
Expand All @@ -166,7 +216,7 @@ PublishScripts/
!**/packages/build/
# Uncomment if necessary however generally it will be regenerated when needed
#!**/packages/repositories.config
# NuGet v3's project.json files produces more ignorable files
# NuGet v3's project.json files produces more ignoreable files
*.nuget.props
*.nuget.targets

Expand All @@ -178,11 +228,12 @@ csx/
ecf/
rcf/

# Windows Store app package directories and files
# Microsoft Azure ApplicationInsights config file
ApplicationInsights.config

# Windows Store app package directory
AppPackages/
BundleArtifacts/
Package.StoreAssociation.xml
_pkginfo.txt

# Visual Studio cache files
# files ending in .cache can be ignored
Expand All @@ -192,19 +243,16 @@ _pkginfo.txt

# Others
ClientBin/
[Ss]tyle[Cc]op.*
~$*
*~
*.dbmdl
*.dbproj.schemaview
*.jfm
*.pfx
*.publishsettings
node_modules/
orleans.codegen.cs

# Since there are multiple workflows, uncomment next line to ignore bower_components
# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
#bower_components/

# RIA/Silverlight projects
Generated_Code/

Expand All @@ -219,7 +267,6 @@ UpgradeLog*.htm
# SQL Server files
*.mdf
*.ldf
*.ndf

# Business Intelligence projects
*.rdl.data
Expand All @@ -234,20 +281,13 @@ FakesAssemblies/

# Node.js Tools for Visual Studio
.ntvs_analysis.dat
node_modules/

# Typescript v1 declaration files
typings/

# Visual Studio 6 build log
*.plg

# Visual Studio 6 workspace options file
*.opt

# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
*.vbw

# Visual Studio LightSwitch build output
**/*.HTMLClient/GeneratedArtifacts
**/*.DesktopClient/GeneratedArtifacts
Expand All @@ -256,33 +296,15 @@ typings/
**/*.Server/ModelManifest.xml
_Pvt_Extensions

# LightSwitch generated files
GeneratedArtifacts/
ModelManifest.xml

# Paket dependency manager
.paket/paket.exe
paket-files/

# FAKE - F# Make
.fake/

# JetBrains Rider
.idea/
*.sln.iml

# CodeRush
.cr/

# Python Tools for Visual Studio (PTVS)
__pycache__/
*.pyc

# Cake - Uncomment if you are using it
# tools/**
# !tools/packages.config

# Telerik's JustMock configuration file
*.jmconfig

# BizTalk build output
*.btp.cs
*.btm.cs
*.odx.cs
*.xsd.cs
*.StyleCop
/API_Keys
33 changes: 33 additions & 0 deletions Installation.md
@@ -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.
6 changes: 6 additions & 0 deletions NuGet.config
@@ -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>
26 changes: 16 additions & 10 deletions README.md
@@ -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)

0 comments on commit dd90f6c

Please sign in to comment.