moved to yarn, updated README and .gitignore

diff --git a/.gitignore b/.gitignore
index 62207ba85874995181316014cbf96a2389c41c07..a438d13845edcd86907d32208931470ff9484eda 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -2,3 +2,5 @@
 /node_modules
 
 .DS_Store
+
+yarn.lock

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..9f9c707
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# nodeaudio
+
+## Building
+
+Clean and build:
+
+    node-gyp rebuild
+
+There is a custom, prebuilt PortAudio library (libportaudio.dylib) in portaudio/bin that is copied over to the rpath (build/Release) before the actual build. During build, it is dynamically linked to nodeaudio.node (the main binary).  This will NOT work (potentially at runtime) unless PortAudio has the correct install path. Run through the steps below if libportaudio.dylib changes:
+
+Update the install path of PortAudio:
+
+    install_name_tool -id "@loader_path/libportaudio.dylib" libportaudio.dylib
+
+To see what libraries a Mach-O exe requires:
+
+    otool -L build/Release/nodeAudio.node
+
+## Publishing
+
+The publishing config is defined in .npmrc (url and credentials).  API_TOKEN is a GitLab token with the api scope.
+
+As of writing, publishing will fail if there is already a package in the registry.
+
+### !! NPM vs Yarn
+I was unable to figure out how to publish to the private GitLab repo using npm (400 Bad Request).  This may just be a bug in npm.  For real, this threw me for a loop.  I had to switch to Yarn for this reason (v1.22.17).  Pulling with npm works fine though (for other repos).
+
+### TODO
+Sign on build
\ No newline at end of file