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.

Sign up for GitHub

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

Jump to bottom

Added reference to the openxml open docs in the SDK readme. #1

Closed
wants to merge 2 commits into from
Closed

Added reference to the openxml open docs in the SDK readme. #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2fc2d7a
Added reference to Open XML Documentation
dorreneb Jun 24, 2014
8ef4c13
Removed specific username references from readme.md
dorreneb Jun 24, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
85 changes: 45 additions & 40 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
Open-XML-SDK
============
#Open-XML-SDK

The Open XML SDK provides open-source libraries for working with Open XML
Documents (DOCX, XLSX, and PPTX). It supports scenarios such as:

- High-performance generation of word-processing documents, spreadsheets,
and presentations
- Document modification, such as removing tracked revisions or removing
Expand All @@ -13,49 +14,53 @@ Copyright (c) Microsoft Open Technologies, Inc. All rights reserved.
Licensed under the Apache License, Version 2.0.
See License.txt in the project root for license information.

Build Instructions
==================

Note: for this first release, you must have some version of Visual Studio
installed. Visual Studio 2012 Express Edition will work just fine:
http://www.microsoft.com/en-us/download/details.aspx?id=34673

Set Execution Policy for PowerShell
===================================
In order to run the script that builds the Open XML SDK, you need to set
the execution policy. To set the execution policy, you must run
PowerShell as administrator.
1. Right click on the PowerShell shortcut, and click "Run as administrator".
An easy way to find the PowerShell shortcut is to click the Start
button, then type PowerShell. The PowerShell shortcut will be in the
search results above the start menu.
#Build Instructions

**Note: for this first release, you must have some version of Visual Studio
installed. [Visual Studio 2012 Express Edition](http://www.microsoft.com/en-us/download/details.aspx?id=34673) will work just fine.**


##Set Execution Policy for PowerShell

In order to run the script that builds the Open XML SDK, you need to set the execution policy. To set the execution policy, you must run PowerShell as administrator.

1. Right click on the PowerShell shortcut, and click "Run as administrator". An easy way to find the PowerShell shortcut is to click the Start button, then type PowerShell. The PowerShell shortcut will be in the search results above the start menu.
2. Click the Yes button in the User Account Control dialog box.
3. Run the command to set the execution policy:
Type:
PS C:\Windows\system32> Set-ExecutionPolicy Unrestricted<Enter>

`PS C:\Windows\system32> Set-ExecutionPolicy Unrestricted`
4. The Set-ExecutionPolicy cmdlet asks:
Do you want to change the execution policy?
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"):
Press <Enter>
5. You can exit the PowerShell session that is running as administrator.
Type:
PS C:\Windows\system32> Exit<Enter>

Build the Open XML SDK Libraries
================================
1. Start a Visual Studio command prompt. It does not need to run as
administrator.
> Do you want to change the execution policy?

> [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"):

Press Enter to accept and continue.

5. You can exit the PowerShell session that is running as administrator by typing:

`PS C:\Windows\system32> Exit`

##Build the Open XML SDK Libraries
1. Start a Visual Studio command prompt. It does not need to run as administrator.
2. Change directories into the directory that contains this README.md,
and the PowerShell script BldSdk.ps1
For instance, type:
C:> CD C:\users\<username>\Documents\Open-Xml-Sdk<Enter>
and the PowerShell script BldSdk.ps1

`C:> CD C:\users\<username>\Documents\Open-Xml-Sdk`
3. Start PowerShell.
Type:
C:> PowerShell<Enter>

`C:> PowerShell`
4. Run the PowerShell script to build the libraries:
Type:
PS C:\users\Eric\Documents\Open-Xml-Sdk> ./BldSdk.ps1<Enter>

`PS C:\users\<username>\Documents\Open-Xml-Sdk> ./BldSdk.ps1`

The build will commence - it can take a few seconds, up to a minute,
depending on the speed of your computer.
5. Find the debug libraries in the folder: ./build/OpenXmlSdkLib/Debug
Find the release libraries in the folder: ./build/OpenXmlSdkLib/Release
5. Find the debug libraries in the folder:

`./build/OpenXmlSdkLib/Debug`
6. Find the release libraries in the folder:

`./build/OpenXmlSdkLib/Release`

#Open XML SDK Documentation
The Open XML SDK conceptual documentation is also open for use and contribution under the [Creative Commons Attribution-NonCommercial-NoDerivs 3.0 United States](https://creativecommons.org/licenses/by-nc-nd/3.0/us) license. You can find it in the [office-content repository](http://github.com/officedev/office-content) under the OfficeDev org.