-
Notifications
You must be signed in to change notification settings - Fork 1
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
Showing
1 changed file
with
70 additions
and
45 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,45 +1,70 @@ | ||
| # FsSpreadsheet | ||
| Spreadsheet creation and manipulation in FSharp | ||
|
|
||
| ## DSL | ||
| ```fsharp | ||
| #r "nuget: FsSpreadsheet" | ||
| open FsSpreadsheet.DSL | ||
| let dslTree = | ||
| workbook { | ||
| sheet "MySheet" { | ||
| row { | ||
| cell {1} | ||
| cell {2} | ||
| cell {3} | ||
| } | ||
| row { | ||
| 4 | ||
| 5 | ||
| 6 | ||
| } | ||
| } | ||
| } | ||
| let spreadsheet = dslTree.Value.Parse() | ||
| ``` | ||
| ## ExcelIO | ||
|
|
||
| ```fsharp | ||
| #r "nuget: FsSpreadsheet.ExcelIO" | ||
| open FsSpreadsheet.ExcelIO | ||
| spreadsheet.ToFile(excelFilePath) | ||
| ``` | ||
|
|
||
| -------> | ||
|
|
||
|  | ||
|
|
||
| # FsSpreadsheet | ||
| Spreadsheet creation and manipulation in FSharp | ||
|
|
||
| ## DSL | ||
| ```fsharp | ||
| #r "nuget: FsSpreadsheet" | ||
| open FsSpreadsheet.DSL | ||
| let dslTree = | ||
| workbook { | ||
| sheet "MySheet" { | ||
| row { | ||
| cell {1} | ||
| cell {2} | ||
| cell {3} | ||
| } | ||
| row { | ||
| 4 | ||
| 5 | ||
| 6 | ||
| } | ||
| } | ||
| } | ||
| let spreadsheet = dslTree.Value.Parse() | ||
| ``` | ||
| ## ExcelIO | ||
|
|
||
| ```fsharp | ||
| #r "nuget: FsSpreadsheet.ExcelIO" | ||
| open FsSpreadsheet.ExcelIO | ||
| spreadsheet.ToFile(excelFilePath) | ||
| ``` | ||
|
|
||
| -------> | ||
|
|
||
|  | ||
|
|
||
| ## Develop | ||
|
|
||
| ### Build QuickStart | ||
|
|
||
| If not already done, | ||
| 1. install .NET SDK | ||
| 2. install Node.js | ||
|
|
||
| In any shell, run | ||
| 1. `dotnet tool restore` | ||
| 4. `npm install` | ||
| 5. `build.cmd <target>` where `<target>` may be | ||
| - if `<target>` is empty, it just runs dotnet build after cleaning everything | ||
| - `runtests` to run unit tests | ||
| - `runtestsjs` to only run JS unit tests | ||
| - `runtestsdotnet` to only run .NET unit tests | ||
| - `releasenotes semver:<version>` where `<version>` may be `major`, `minor`, or `patch` to update RELEASE_NOTES.md | ||
| - `pack` to create a NuGet release | ||
| - `packprelease` to create a NuGet prerelease | ||
| - `builddocs` to create docs | ||
| - `builddocsprerelease` to create prerelease docs | ||
| - `watchdocs` to create docs and run them locally | ||
| - `watchdocsprelease` to create prerelease docs and run them locally | ||
| - `publishnuget` to create a NuGet release and publish it | ||
| - `publishnugetprelease` to create a NuGet prerelease and publish it |