proto2js/readme.md

27 lines
586 B
Markdown
Raw Permalink Normal View History

2022-05-26 06:24:38 +02:00
# proto2js
Compile *.proto file to JavaScript module
2022-05-26 06:52:25 +02:00
## Table of Contents
0. [General](#General)
1. [GTFS Realtime](#gtfs-realtime)
# General
2022-05-26 06:56:24 +02:00
This repository provides three folders for each compilation.
2022-05-26 06:52:25 +02:00
1. ```doc```: Documentation
2. ```proto```: Source file
3. ```js```: Result file
2023-02-15 14:11:44 +01:00
The tool used for compilation is called
2022-05-26 06:52:25 +02:00
[pbf](https://github.com/mapbox/pbf)
and installed in a global fashion like this.
```
$ npm install -g pbf
```
2022-05-26 06:56:24 +02:00
A compilation is done by calling the following instruction.
2022-05-26 06:52:25 +02:00
```
pbf ./proto/<file.proto> > ./js/<file.js>
```
2022-05-26 06:56:24 +02:00
# [GTFS Realtime](./doc/gtfs-rt.md)