This is an automated email from the ASF dual-hosted git repository.
curth pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-dotnet.git
The following commit(s) were added to refs/heads/main by this push:
new ccd5bfa docs: Update README.md (#236)
ccd5bfa is described below
commit ccd5bfa6d523d5bc31ad3d2d33b34fd930f952b8
Author: myd7349 <[email protected]>
AuthorDate: Thu Dec 25 02:36:57 2025 +0800
docs: Update README.md (#236)
## What's Changed
Update README.md:
- Fix dead links;
- Add syntax highlighting for sample code;
Preview:
https://github.com/myd7349/arrow-dotnet/tree/update-readme
---
README.md | 35 ++++++++++++++++++-----------------
1 file changed, 18 insertions(+), 17 deletions(-)
diff --git a/README.md b/README.md
index a38602c..a003dd3 100644
--- a/README.md
+++ b/README.md
@@ -48,23 +48,24 @@ for currently available features.
# Usage
- using System.Diagnostics;
- using System.IO;
- using System.Threading.Tasks;
- using Apache.Arrow;
- using Apache.Arrow.Ipc;
-
- public static async Task<RecordBatch> ReadArrowAsync(string filename)
+```csharp
+using System.Diagnostics;
+using System.IO;
+using System.Threading.Tasks;
+using Apache.Arrow;
+using Apache.Arrow.Ipc;
+
+public static async Task<RecordBatch> ReadArrowAsync(string filename)
+{
+ using (var stream = File.OpenRead(filename))
+ using (var reader = new ArrowFileReader(stream))
{
- using (var stream = File.OpenRead(filename))
- using (var reader = new ArrowFileReader(stream))
- {
- var recordBatch = await reader.ReadNextRecordBatchAsync();
- Debug.WriteLine("Read record batch with {0} column(s)",
recordBatch.ColumnCount);
- return recordBatch;
- }
+ var recordBatch = await reader.ReadNextRecordBatchAsync();
+ Debug.WriteLine("Read record batch with {0} column(s)",
recordBatch.ColumnCount);
+ return recordBatch;
}
-
+}
+```
# Status
@@ -191,8 +192,8 @@ This project follows the coding style specified in [Coding
Style](https://github
# Updating FlatBuffers code
-See
https://google.github.io/flatbuffers/flatbuffers_guide_use_java_c-sharp.html
for how to get the `flatc` executable.
+See https://flatbuffers.dev/languages/c_sharp/ for how to get the `flatc`
executable.
-Run `flatc --csharp` on each `.fbs` file in the [format](../format) folder.
And replace the checked in `.cs` files under
[FlatBuf](src/Apache.Arrow/Flatbuf) with the generated files.
+Run `flatc --csharp` on each `.fbs` file in the [format](./format) folder. And
replace the checked in `.cs` files under [FlatBuf](src/Apache.Arrow/Flatbuf)
with the generated files.
Update the non-generated [FlatBuffers](src/Apache.Arrow/Flatbuf/FlatBuffers)
`.cs` files with the files from the [google/flatbuffers
repo](https://github.com/google/flatbuffers/tree/master/net/FlatBuffers).
