oribuild-linux-arm64 0.0.0-pre-alpha.1 → 0.0.0-pre-alpha.4

package/README.md

@@ -105,14 +105,41 @@ ori -h
 ## Working on `ori`
 ### Getting Dependencies
 -   install go 1.17 https://go.dev/doc/install
--   install mingw-gcc. I do this via https://www.mingw-w64.org/downloads/#mingw-builds (the sourceforge link at present)
-    - If the live installer fails, you can download the prebuilt binaries directly and add those to your path
-      https://sourceforge.net/projects/mingw-w64/files/Toolchains%20targetting%20Win64/
-    - Prebuilt binaries require 7zip to extract https://www.7-zip.org/
-    - I installed x86_64-posix-seh
-    This is to support building libsass https://github.com/wellington/go-libsass/issues/37
--   get the install path of mingw-gcc's bin and add it to your path (in my case /c/Program Files/mingw-w64/x86_64-8.1.0-posix-seh-rt_v6-rev0/mingw64/bin)
--   Install the golang vscode plugin, and click "Install All" when it prompts you to install missing golang components (godef, gopkgs, gopls)
+-   If on windows, install mingw-gcc.
+      This is to support building libsass on windows https://github.com/wellington/go-libsass/issues/37
+      
+      There are two ways to do this right now:
+      1. **Via Chocolatey**:
+            - Install [Chocolatey](https://chocolatey.org/)
+            - Install mingw from chocolatey `choco install mingw`. At time of writing this installs `mingw 11.2.0.07112021`
+      2. **Manually**: do this only if you encounter issues with the version distributed by `chocolatey`:
+
+            - Get a build from https://www.mingw-w64.org/downloads/#mingw-builds (the sourceforge link)
+            - If the live installer fails, you can download the prebuilt binaries directly and add those to your path
+            https://sourceforge.net/projects/mingw-w64/files/Toolchains%20targetting%20Win64/
+            - Prebuilt binaries require 7zip to extract https://www.7-zip.org/
+            - I installed x86_64-posix-seh
+-   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)
+-   _(Optional, but recommended)_ Install the `go` vscode plugin, and click "Install All" when it prompts you to install missing golang components (godef, gopkgs, gopls)
+
+### Running ori from this repo
+1. Set up a build.json and patches directory in your target project.
+
+      See above for the build.json fields
+
+      > TODO: document the patches directory
+
+      > TODO: make a an example of an oribuild project + config (#10)
+      
+
+2. Building and Running
+
+      ```sh
+      cd oribuild
+      go run . -c ../path/to/build.json`
+      ```
+
+      The first time you run this, go will fetch and build all the dependencies in oribuild/go.mod
 
 ### Catches
 
@@ -158,6 +185,19 @@ go tool pprof -http=localhost:8080 traces/cpu.pprof.incremental*
 
 # Analyse traces
 go tool trace traces/trace.out.*
+
+# cutting a new release, from root dir
+# first, update the version numbers in dist/oribuild/package.json,
+# and update the dependency versions to the same version number.
+git commit -m "bump to 0.0.0-pre-alpha.4"
+git tag v0.0.0-pre-alpha.4
+git push
+git push --tags
+# this reads the version numbers from dist/oribuild/package.json
+# and generates new packages.
+./scripts/build-everything.sh
+# this publishes to npm (you'll have to npm login separately)
+./scripts/publish-everything.sh
 ```
 
 ## FAQs

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "oribuild-linux-arm64",
-  "version": "0.0.0-pre-alpha.1",
+  "version": "0.0.0-pre-alpha.4",
   "repository": {
     "url": "https://github.com/microsoft/ori"
   },
   "os": [
-    "x64"
+    "linux"
   ],
   "cpu": [
-    "linux"
+    "arm64"
   ],
   "bin": {
     "ori": "./platform-unimplemented.js"