geofeed-tools/README.md

38 lines
991 B
Markdown
Raw Normal View History

2024-12-30 21:31:36 +08:00
![geofeed-validator](https://socialify.git.ci/realSunyz/geofeed-tools/image?description=1&descriptionEditable=&font=Jost&language=1&name=1&owner=1&pattern=Circuit%20Board&theme=Auto)
2024-12-28 22:01:13 +08:00
This utility is used to validate the format of geofeed files.
> [!NOTE]
> The project is still under development. The code on the main branch is stable and usable.
## Usage
### Compile
```bash
# Clone the repository
git clone https://github.com/realSunyz/geofeed-validator.git
# Navigate to the directory
2024-12-31 16:23:54 +08:00
cd geofeed-tools/src
2024-12-28 22:01:13 +08:00
# Synchronize and clean up dependencies
go mod tidy
# Build the executable file
2024-12-31 16:23:54 +08:00
go build -o geofeed-tools
2024-12-28 22:01:13 +08:00
```
### Run
```bash
2024-12-31 16:23:54 +08:00
./geofeed-tools <path_to_geofeed.csv>
2024-12-28 22:01:13 +08:00
```
## Contributing
Issues and Pull Requests are definitely welcome!
Please make sure you have tested your code locally before submitting a PR.
## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/realSunyz/geofeed-validator/blob/main/LICENSE) file for details.