oribuild-linux-arm64 0.0.0-pre-alpha.2 → 0.0.0-pre-alpha.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -122,6 +122,25 @@ ori -h
|
|
|
122
122
|
- Add the path of mingw-gcc's bin to your path (in my case /c/Program Files/mingw-w64/x86_64-8.1.0-posix-seh-rt_v6-rev0/mingw64/bin)
|
|
123
123
|
- _(Optional, but recommended)_ Install the `go` vscode plugin, and click "Install All" when it prompts you to install missing golang components (godef, gopkgs, gopls)
|
|
124
124
|
|
|
125
|
+
### Running ori from this repo
|
|
126
|
+
1. Set up a build.json and patches directory in your target project.
|
|
127
|
+
|
|
128
|
+
See above for the build.json fields
|
|
129
|
+
|
|
130
|
+
> TODO: document the patches directory
|
|
131
|
+
|
|
132
|
+
> TODO: make a an example of an oribuild project + config (#10)
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
2. Building and Running
|
|
136
|
+
|
|
137
|
+
```sh
|
|
138
|
+
cd oribuild
|
|
139
|
+
go run . -c ../path/to/build.json`
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
The first time you run this, go will fetch and build all the dependencies in oribuild/go.mod
|
|
143
|
+
|
|
125
144
|
### Catches
|
|
126
145
|
|
|
127
146
|
> Add more here as you hit unexpected situations
|
|
@@ -166,6 +185,19 @@ go tool pprof -http=localhost:8080 traces/cpu.pprof.incremental*
|
|
|
166
185
|
|
|
167
186
|
# Analyse traces
|
|
168
187
|
go tool trace traces/trace.out.*
|
|
188
|
+
|
|
189
|
+
# cutting a new release, from root dir
|
|
190
|
+
# first, update the version numbers in dist/oribuild/package.json,
|
|
191
|
+
# and update the dependency versions to the same version number.
|
|
192
|
+
git commit -m "bump to 0.0.0-pre-alpha.4"
|
|
193
|
+
git tag v0.0.0-pre-alpha.4
|
|
194
|
+
git push
|
|
195
|
+
git push --tags
|
|
196
|
+
# this reads the version numbers from dist/oribuild/package.json
|
|
197
|
+
# and generates new packages.
|
|
198
|
+
./scripts/build-everything.sh
|
|
199
|
+
# this publishes to npm (you'll have to npm login separately)
|
|
200
|
+
./scripts/publish-everything.sh
|
|
169
201
|
```
|
|
170
202
|
|
|
171
203
|
## FAQs
|