summaryrefslogtreecommitdiff
path: root/marching/Assets/ThirdParty/CSV-Parser/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'marching/Assets/ThirdParty/CSV-Parser/README.md')
-rw-r--r--marching/Assets/ThirdParty/CSV-Parser/README.md102
1 files changed, 102 insertions, 0 deletions
diff --git a/marching/Assets/ThirdParty/CSV-Parser/README.md b/marching/Assets/ThirdParty/CSV-Parser/README.md
new file mode 100644
index 0000000..c87aaef
--- /dev/null
+++ b/marching/Assets/ThirdParty/CSV-Parser/README.md
@@ -0,0 +1,102 @@
+# CSV Parser for C#
+
+[![Test](https://github.com/yutokun/CSV-Parser/actions/workflows/test.yml/badge.svg)](https://github.com/yutokun/CSV-Parser/actions/workflows/test.yml)
+
+CSV Parser with CC0 License.
+
+Best for:
+
+- [Unity](https://unity3d.com/) projects that requires cross-platform CSV parser. (maybe works on any platform supported by Unity)
+- Commercial products that you could not display the license.
+
+## Prerequisites
+
+| Environment | Prerequisites |
+| ----------------------- | ------------------------------------------------------------------------- |
+| Unity 2019.2 or later | None |
+| Unity 2019.1 or earlier | .NET 4.x Equivalent |
+| .NET Project | [System.Memory](https://www.nuget.org/packages/System.Memory/) from NuGet |
+
+## Download
+
+Download zip or unitypackage from [**Releases**](https://github.com/yutokun/CSV-Parser/releases).
+
+## Usage
+
+### Methods
+
+This returns CSV data as `List<List<string>>`.
+
+```c#
+CSVParser.LoadFromString(string data)
+```
+
+or
+
+```c#
+CSVParser.LoadFromPath(string path, Encoding encoding = null)
+```
+
+### Examples
+
+```c#
+var sheet = CSVParser.LoadFromString(csvString);
+
+var styled = new StringBuilder();
+foreach (var row in sheet)
+{
+ styled.Append("| ");
+
+ foreach (var cell in row)
+ {
+ styled.Append(cell);
+ styled.Append(" | ");
+ }
+
+ styled.AppendLine();
+}
+
+Debug.Log(styled.ToString()); // Unity
+Console.WriteLine(styled.ToString()); // C#
+```
+
+## Specs
+
+Compliant with [RFC 4180](http://www.ietf.org/rfc/rfc4180.txt).
+
+- Correctly parse new lines, commas, quotation marks inside cell.
+- Escaped double quotes.
+- Some encoding types. (default UTF-8)
+
+## Beta
+
+- Tab delimiter support
+
+- Async loading
+
+## Development
+
+The repository contains multiple types of newline code. Run `git config core.autocrlf false` in your local repository.
+
+## Why this repo has multiple Unity Examples?
+
+One of the reasons is to check operation in different Unity versions. Another one is to build .unitypackage with CI.
+
+Unity changes a lot between their Tech Streams. It leads different requisites / dependency to the parser. Affected changes below.
+
+| Versions | Difference |
+| ----------------- | ---------------------------------------------- |
+| 2019.1 and 2019.2 | Has Scripting Runtime Version selector or not. |
+| 2021.1 and 2021.2 | Requires additional DLLs or not. |
+
+## License
+
+### Unique part of the repository
+
+[CC0](https://creativecommons.org/publicdomain/zero/1.0/) or [Public Domain](LICENSE)
+
+### .NET Runtimes (included in the .unitypackage for old Unity)
+
+[The MIT License](https://github.com/dotnet/runtime/blob/main/LICENSE.TXT)
+
+Copyright (c) .NET Foundation and Contributors