From 5f903ec592c55b537b94d5815fd1b10f57492031 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maja=20Nedeljkovi=C4=87?= Date: Sun, 17 Apr 2016 16:00:05 +0200 Subject: [PATCH] fix(Deploy): packing script and and README fixes. --- README.md | 9 ++++++--- cli/pack.sh | 2 +- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c55de43..1f9cb53 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,9 @@ # Cottontail +## Installation -## Packaging -Running `npm run package` in the root project folder will produce a tarball in the "release" subfolder. +Download the tarball of the latest release on the [releases page](https://github.com/rabix/cottontail/releases). -## Unpacking 1. Either use your OS to unpack the tar, or run `tar -zxf {archive_name} -C {output_folder}`. 2. Run `sudo npm link` to create the `cottontail` global symlink. 3. Use it by running `cottontail [directory (optional)] [-o (open browser, optional)] [--port 1337 (optional)]` @@ -12,6 +11,10 @@ Running `npm run package` in the root project folder will produce a tarball in t In order to improve our software, we may report runtime errors back to our servers. If you explicitly wish to disable this, you can add a `--no-error-reporting` parameter to the CLI command. +## Packaging + +Running `npm run package` in the root project folder will produce a tarball in the "release" subfolder. + ## Local Development Local cottontail requires the following dependencies: diff --git a/cli/pack.sh b/cli/pack.sh index 9591308..29f015c 100755 --- a/cli/pack.sh +++ b/cli/pack.sh @@ -6,7 +6,7 @@ filename="cottontail-$(date +'%Y-%m-%d').tar.gz" cd ../ echo "Packaging..." -tar --exclude="$currentDirName/release" --exclude="$currentDirName/client/node_modules" --exclude="$currentDirName/client/src/editors/node_modules" -zcf $filename $currentDirName +tar --exclude="$currentDirName/release" --exclude="$currentDirName/client/node_modules" --exclude="$currentDirName/client/src" --exclude="$currentDirName/.git" --exclude="$currentDirName/client/dist" --exclude="$currentDirName/client/src/editors/node_modules" -zcf $filename $currentDirName echo "Created $currentDirName/release/$filename"