Skip to content

Commit

Permalink
Add Readme files for multiple libraries
Browse files Browse the repository at this point in the history
This commit adds readme files for several libraries that were missing. These readme files contain brief introductions about what each library does. This is to provide more context and aid understanding for users or contributors who might encounter these libraries.
In short, this update aims to improve documentation and readability of the project.
  • Loading branch information
frankhaugen committed Sep 24, 2023
1 parent 4188f8a commit 0574272
Show file tree
Hide file tree
Showing 29 changed files with 59 additions and 5 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Frank.Libraries.AutoFixture

## Introduction
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Frank.Libraries.AzureServiceBus

## Introduction
This library contains classes that can be used to interact with Azure Service Bus.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Readme
4 changes: 4 additions & 0 deletions src/Frank.Libraries.Brreg/Frank.Libraries.Brreg/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Frank.Libraries.Brreg

## Introduction
This library contains classes that can be used to retrieve information from the Norwegian Brønnøysund Register Centre (Brønnøysundregistrene). The Brønnøysund Register Centre is a Norwegian government agency that is responsible for the Norwegian business register. The Brønnøysund Register Centre is located in the town of Brønnøysund, Norway.
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Frank.Libraries.Calculators

## Introduction
This library contains classes that can be used to perform calculations.
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Frank.Libraries.CodeGeneration

## Introduction
This library contains classes that can be used to generate code.
4 changes: 4 additions & 0 deletions src/Frank.Libraries.Csv/Frank.Libraries.Csv/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Frank.Libraries.Csv

## Introduction
This library contains classes that can be used to read and write CSV files.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Readme
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Readme
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Readme
1 change: 1 addition & 0 deletions src/Frank.Libraries.Enums/Frank.Libraries.Enums/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Readme
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Readme
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Readme
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Readme
1 change: 1 addition & 0 deletions src/Frank.Libraries.IRC/Frank.Libraries.IRC/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Readme
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Readme
1 change: 1 addition & 0 deletions src/Frank.Libraries.ML/Frank.Libraries.ML/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Readme
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Readme
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Readme
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Readme
1 change: 1 addition & 0 deletions src/Frank.Libraries.Rest/Frank.Libraries.Rest/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Readme
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Readme
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Readme
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Readme
1 change: 1 addition & 0 deletions src/Frank.Libraries.Time/Frank.Libraries.Time/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Readme
10 changes: 10 additions & 0 deletions src/Frank.Libraries.Ubl/Frank.Libraries.Ubl/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Frank.Libraries.Ubl

## Introduction
Ubl stands for Universal Business Language/Ledger. It is a standard for electronic business documents. This library contains the classes that represent the Ubl documents.

UBL 2.1 is the latest version of the UBL standard. The UBL 2.1 schemas are available at [https://docs.oasis-open.org/ubl/os-UBL-2.1/UBL-2.1.html](https://docs.oasis-open.org/ubl/os-UBL-2.1/UBL-2.1.html).

The organization that maintains the UBL standard is OASIS. The OASIS website is [https://www.oasis-open.org/](https://www.oasis-open.org/).

This is unofficial C# code that is generated from the UBL 2.1 schemas. Nothing is guaranteed. Use at your own risk.
1 change: 1 addition & 0 deletions src/Frank.Libraries.Xml/Frank.Libraries.Xml/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Readme
1 change: 1 addition & 0 deletions src/Shared/TestingInfrastructure/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Readme
10 changes: 5 additions & 5 deletions src/global.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"sdk": {
"version": "7.0.0",
"rollForward": "latestMajor",
"allowPrerelease": false
}
"sdk": {
"version": "7.0.0",
"rollForward": "latestMajor",
"allowPrerelease": false
}
}

0 comments on commit 0574272

Please sign in to comment.