summaryrefslogtreecommitdiff
path: root/README
blob: 20a904695c3adfcb32742e340da4b9dca0317488 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# This app auto-generates *.pb.go files
#
# it'll also auto-increment with --renumber
#
# It assumes you are doing GO development in ~/go/src
# 	Although it might work with go.work directory setups
#	I haven't tested that much yet because I haven't had time

# This app DOES NOT LIKE THINGS WHEN THE PATHS ARE NOT ABSOLUTE GO namespace paths
# 	that is, if you make a go.work file and tell it gitea.mystuff.org/foo is actually in foo/
# 	none of the autogen things will probably work. Notsure. Anyway, it's not interesting
# 	to me to try that since this is hard enough already I don't have time to debug that
#	but will of course accept patches

# It was designed to work on .proto files designed with a .proto standard

* This will generate:
* Marshal() functions (to protoWIRE, protoTEXT and protoJSON)
* SortBy() functions
* FindBy() functions
* DeleteBy() functions
* AppendBy() functions
* Http() functions
* Gui() functions
* PrintTable() functions
* Save() & Load() functions

# See the examples/ for a sample fruit.proto file that documents what is needed

# You will notice if you have checked out this project the *pb.go files are ignored in the .gitignore
# file. See the app 'forge' on how publishing and versioning works with this codebase.