Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rabanti-github committed Apr 25, 2023
1 parent b9b2d65 commit 3a60fde
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 9 deletions.
18 changes: 13 additions & 5 deletions Documentation/CodeDocumentation.shfbproj
Original file line number Diff line number Diff line change
Expand Up @@ -87,34 +87,42 @@ Please note that the demo project of the .NET Standard version will not work in
&lt%3bh3&gt%3bDocumentation project&lt%3b/h3&gt%3b
If you want to compile the documentation project %28folder: Documentation%3b project file: shfbproj%29, you need also the &lt%3bstrong&gt%3b&lt%3ba href=&quot%3bhttps://github.com/EWSoftware/SHFB&quot%3b&gt%3bSandcastle Help File Builder %28SHFB%29&lt%3b/a&gt%3b&lt%3b/strong&gt%3b. It is also freely available. But you don’t need the documentation project to build the NanoXLSX library.
&lt%3bp&gt%3bThe .NET version of the documentation may vary, based on the installation. If v4.5 is not available, upgrade to target to a newer version, like v4.6&lt%3b/p&gt%3b

&lt%3bh3&gt%3bUtility dependencies&lt%3b/h3&gt%3b
&lt%3bp&gt%3bThe Test project and GitHub Actions may also require dependencies like unit testing frameworks or workflow steps. However, &lt%3bb&gt%3bnone of these dependencies are essential to build the library&lt%3b/b&gt%3b. They are just utilities. The test dependencies ensure efficient unit testing and code coverage. The GitHub Actions dependencies are used for the automatization of releases and API documentation&lt%3b/p&gt%3b

&lt%3bh2&gt%3bInstallation&lt%3b/h2&gt%3b

&lt%3bh3&gt%3bUsing NuGet&lt%3b/h3&gt%3b

&lt%3bh4&gt%3bBy Package Manager:&lt%3b/h4&gt%3b
&lt%3bpre&gt%3bInstall-Package PicoXLSX&lt%3b/pre&gt%3b
&lt%3bpre style=&quot%3bpadding:1em%3bcolor:Blue%3bbackground-color:LightGray%3b&quot%3b&gt%3bInstall-Package PicoXLSX&lt%3b/pre&gt%3b

&lt%3bh4&gt%3bBy .NET CLI:&lt%3b/h4&gt%3b
&lt%3bpre&gt%3bdotnet add package PicoXLSX&lt%3b/pre&gt%3b
&lt%3bpre style=&quot%3bpadding:1em%3bcolor:Blue%3bbackground-color:LightGray%3b&quot%3b&gt%3bdotnet add package PicoXLSX&lt%3b/pre&gt%3b

&lt%3bh3&gt%3bAs DLL&lt%3b/h3&gt%3b

Simply place the NanoXLSX DLL into your .NET project and add a reference to it. Please keep in mind that the .NET version of your solution must match with the runtime version of the NanoXLSX DLL %28currently compiled with 4.5 and .NET Standard 2.0%29.
&lt%3bh3&gt%3bAs source files&lt%3b/h3&gt%3b

Place all .CS files from the NanoXLSX source folder and its sub-folders into your project. In case of the .NET &amp%3bgt%3b=4.5 version, the necessary dependencies have to be referenced as well.


&lt%3bh2&gt%3bUsage %28Quick Start%29&lt%3b/h2&gt%3b

&lt%3bh2&gt%3bQuick Start %28shortened syntax%29&lt%3b/h2&gt%3b
&lt%3bpre&gt%3b
&lt%3bpre style=&quot%3bpadding:1em%3bcolor:Blue%3bbackground-color:LightGray%3b&quot%3b&gt%3b
Workbook workbook = new Workbook%28&amp%3bquot%3bmyWorkbook.xlsx&amp%3bquot%3b, &amp%3bquot%3bSheet1&amp%3bquot%3b%29%3b // Create new workbook with a worksheet called Sheet1
workbook.WS.Value%28&amp%3bquot%3bSome Data&amp%3bquot%3b%29%3b // Add cell A1
workbook.WS.Formula%28&amp%3bquot%3b=A1&amp%3bquot%3b%29%3b // Add formula to cell B1
workbook.WS.Down%28%29%3b // Go to row 2
workbook.WS.Value%28DateTime.Now, Style.BasicStyles.Bold%29%3b // Add formatted value to cell A2
workbook.Save%28%29%3b // Save the workbook as myWorkbook.xlsx
&lt%3b/pre&gt%3b

&lt%3bh2&gt%3bQuick Start %28regular syntax%29&lt%3b/h2&gt%3b
&lt%3bpre&gt%3b
&lt%3bpre style=&quot%3bpadding:1em%3bcolor:Blue%3bbackground-color:LightGray%3b&quot%3b&gt%3b
Workbook workbook = new Workbook%28&amp%3bquot%3bmyWorkbook.xlsx&amp%3bquot%3b, &amp%3bquot%3bSheet1&amp%3bquot%3b%29%3b // Create new workbook with a worksheet called Sheet1
workbook.CurrentWorksheet.AddNextCell%28&amp%3bquot%3bSome Data&amp%3bquot%3b%29%3b // Add cell A1
workbook.CurrentWorksheet.AddNextCell%2842%29%3b // Add cell B1
Expand All @@ -124,7 +132,7 @@ Workbook workbook = new Workbook%28&amp%3bquot%3bmyWorkbook.xlsx&amp%3bq
&lt%3b/pre&gt%3b

&lt%3bh2&gt%3bQuick Start %28read%29&lt%3b/h2&gt%3b
&lt%3bpre&gt%3b
&lt%3bpre style=&quot%3bpadding:1em%3bcolor:Blue%3bbackground-color:LightGray%3b&quot%3b&gt%3b
Workbook wb = Workbook.Load%28&quot%3bbasic.xlsx&quot%3b%29%3b // Read the workbook
System.Console.WriteLine%28&quot%3bcontains worksheet name: &quot%3b + wb.CurrentWorksheet.SheetName%29%3b
foreach %28KeyValuePair&lt%3bstring, Cell&gt%3b cell in wb.CurrentWorksheet.Cells%29
Expand Down
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# NanoXLSX ![NanoXLSX](https://github.com/rabanti-github/NanoXLSX/blob/master/Documentation/icons/NanoXLSX.png)

![nuget](https://img.shields.io/nuget/v/NanoXLSX.svg?maxAge=86400)![license](https://img.shields.io/github/license/rabanti-github/NanoXlsx.svg)[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Frabanti-github%2FNanoXLSX.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Frabanti-github%2FNanoXLSX?ref=badge_shield)
![nuget](https://img.shields.io/nuget/v/NanoXLSX.svg?maxAge=86400)
![license](https://img.shields.io/github/license/rabanti-github/NanoXlsx.svg)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Frabanti-github%2FNanoXLSX.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Frabanti-github%2FNanoXLSX?ref=badge_shield)

NanoXLSX is a small .NET library written in C#, to create and read Microsoft Excel files in the XLSX format (Microsoft Excel 2007 or newer) in an easy and native way

Expand Down Expand Up @@ -65,6 +67,10 @@ If you want to compile the documentation project (folder: Documentation; project

The .NET version of the documentation may vary, based on the installation. If v4.5 is not available, upgrade to target to a newer version, like v4.6

### Utility dependencies

The Test project and GitHub Actions may also require dependencies like unit testing frameworks or workflow steps. However, **none of these dependencies are essential to build the library**. They are just utilities. The test dependencies ensure efficient unit testing and code coverage. The GitHub Actions dependencies are used for the automatization of releases and API documentation

## Installation

### Using NuGet
Expand Down Expand Up @@ -136,7 +142,7 @@ See also: [Getting started in the Wiki](https://github.com/rabanti-github/NanoXL

Hint: You will find most certainly any function, and the way how to use it, in the [Unit Test Project](https://github.com/rabanti-github/NanoXLSX/tree/master/NanoXlsx%20Test)



## License


## License
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Frabanti-github%2FNanoXLSX.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Frabanti-github%2FNanoXLSX?ref=badge_large)

0 comments on commit 3a60fde

Please sign in to comment.