Skip to content

Commit

Permalink
Update Readme for console
Browse files Browse the repository at this point in the history
  • Loading branch information
msftjayongg committed Jun 2, 2016
1 parent 1cfa970 commit 5fcb150
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions Readme-console.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
README: OneNote Console API sample
===================
1 - Overview
===================
The VanillaConsole is a sample console app that a developer can use to bootstrap her own app to automate OneNote.

In order to replace properly use this in your own project, you should:
* replace add-in GUID in vdproj - D5ECCD00-CF2D-409B-B65A-BDBACB9F21DB with a new GUID
* replace Guid in AddIn.cs - D5ECCD00-CF2D-409B-B65A-BDBACB9F21DB
* replace add-in progid in vdproj "MyApplication.VanillaAddIn" with a new ProgId
* replace ProgId in AddIn.cs
* replace all "VanillaAddIn" strings
* replace ProductCode, PackageCode, and UpgradeCode in .vdproj
* replace Guid in [assembly: Guid("45FCCCEB-10CB-4C29-B8D2-1C8033139534")]
* update license.rtf

===================
2 - Dependencies
===================
The project is written in C# and requires .NET 4.5 or above.

==================
3 - Building
==================
Open Visual Studio and build.

==================
4 - Debugging
==================
Set VanillaConsole as the Startup Project, and run it.

5 - Known Issues
==================
There is an issue that can occur whereby the addin will stop installing. To remedy this make sure that all of the project's
interop dlls reference points are set to %systemroot%\assemblies\GAC_MSIL and that they have Embed Interop Types set to false.

0 comments on commit 5fcb150

Please sign in to comment.