Merge pull request #185 from uber/generator-release_0.8.1-master

Generator v0.8.1 release
uber · Nov 5, 2018 · 5d902ac · 5d902ac
2 parents fd7e6dc + 1a28c53
commit 5d902ac
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 8 deletions.
diff --git a/Generator/README.md b/Generator/README.md
@@ -1,6 +1,6 @@
-# needle
+# Needle Code Generator
 
-## Installation
+## Building and developing
 
 ### Compiling from source:
 
@@ -16,12 +16,6 @@ You can then build from the command-line:
 $ swift build
 ```
 
-For a release build with static-linking (so you can share the binary):
-
-```
-$ swift build -c release -Xswiftc -static-stdlib
-```
-
 Or create an Xcode project and build using the IDE:
 
 ```
@@ -33,3 +27,14 @@ Note: For now, the xcconfig is being used to pass in the DEBUG define.
 
 Needle is intended to be heavily multi-threaded. This makes stepping through the code rather complicated. To simplify the debugging process, set the `SINGLE_THREADED` enviroment variable for your `Run` configuration in the Scheme Editor to `1` or `YES`.
 
+## Releasing
+
+1. Compile a binary executable using the following command:
+
+```
+$ swift build -c release -Xswiftc -static-stdlib
+```
+
+2. Copy the resulting binary into the `Generator/bin/` folder, replacing the old binary.
+
+3. Create a new release with the appropriate version number on [GitHub](https://github.com/uber/needle/releases). Make sure the binary executable is included, as an asset, in the GitHub release as well.
diff --git a/Generator/bin/needle b/Generator/bin/needle