Skip to content

Commit d28c056

Browse files
docs: update README
1 parent 9cd0773 commit d28c056

1 file changed

Lines changed: 41 additions & 5 deletions

File tree

README.md

Lines changed: 41 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -94,28 +94,64 @@ foreach (var batch in data.Batches)
9494

9595
- .NET 8.0 or later
9696
- Supported platforms:
97-
- Linux (x64)
97+
- Linux (x64, ARM64) 🚧 Planned
9898
- Windows (x64) 🚧 Planned
99-
- macOS (x64, ARM64) 🚧 Planned
99+
- macOS (ARM64) 🚧 Planned
100100

101101
## Building from Source
102102

103103
### Prerequisites
104104

105-
- .NET 8.0 SDK or later
105+
- .NET 10.0 SDK or later
106106
- Rust toolchain (1.93+) - Install from https://rustup.rs
107107

108108
### Build Steps
109109

110-
TODO: Provide detailed build instructions
110+
1. **Clone the repository:**
111+
```bash
112+
git clone https://github.com/nazarii-piontko/datafusion-sharp.git
113+
cd datafusion-sharp
114+
```
115+
116+
2. **Build the project:**
117+
```bash
118+
dotnet build -c Release
119+
```
120+
121+
This will automatically:
122+
- Compile the Rust native library (via cargo)
123+
- Build the .NET library
124+
- Link the native library into the managed library
125+
126+
3. **Run tests:**
127+
```bash
128+
dotnet test -c Release
129+
```
130+
131+
4. **(Optional) Run benchmarks:**
132+
```bash
133+
cd tests/DataFusionSharp.Benchmark
134+
dotnet run -c Release
135+
```
136+
137+
For detailed benchmark results, see the [Benchmark README](tests/DataFusionSharp.Benchmark/README.md).
138+
139+
5. **(Optional) Build NuGet package:**
140+
```bash
141+
dotnet pack -c Release
142+
```
111143

112144
## Documentation
113145

114146
TODO: Link to or provide documentation for the library
115147

116148
## Project Structure
117149

118-
TODO: Describe the project structure if necessary
150+
- [**src/DataFusionSharp/**](src/DataFusionSharp) - Core .NET library with managed wrappers
151+
- [**native/**](native) - Rust FFI layer bridging .NET to Apache DataFusion
152+
- [**tests/DataFusionSharp.Tests/**](tests/DataFusionSharp.Tests) - Integration tests
153+
- [**tests/DataFusionSharp.Benchmark/**](tests/DataFusionSharp.Benchmark) - Performance benchmarks with native reference implementation
154+
- [**examples/**](examples) - Example usage and sample data
119155

120156
## Contributing
121157

0 commit comments

Comments
 (0)