From f213052dbd79cccbbdfb02a262e21d562ed6206b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maja=20Nedeljkovi=C4=87?= Date: Tue, 26 Apr 2016 13:51:04 +0200 Subject: [PATCH] fix(Deploy): fixed package script, updated readme --- README.md | 14 +++++++++----- cli/pack.sh | 2 +- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1f9cb53..da9c4ae 100644 --- a/README.md +++ b/README.md @@ -2,25 +2,29 @@ ## Installation +Running cottontail requires [NodeJS 4+](https://nodejs.org/en/). + + Download the tarball of the latest release on the [releases page](https://github.com/rabix/cottontail/releases). 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. +2. `cd` into the `cottontail` directory that was just created. 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)]` 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. +> Some users might experience issues running `sudo npm link` on Ubuntu. If the issue is caused by kerberos, installing `libkrb5-dev` seems to solve this: +> +> `sudo apt-get install libkrb5-dev` + ## 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: - -- [NodeJS 4+](https://nodejs.org/en/) -- [Bower](http://bower.io/) +Local cottontail requires [Bower](http://bower.io/). After cloning the repo locally, run the following commands in the root of the cottontail project: diff --git a/cli/pack.sh b/cli/pack.sh index 29f015c..a4f484b 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" --exclude="$currentDirName/.git" --exclude="$currentDirName/client/dist" --exclude="$currentDirName/client/src/editors/node_modules" -zcf $filename $currentDirName +tar --exclude="$currentDirName/release" --exclude="$currentDirName/client/node_modules" --exclude="$currentDirName/.git" --exclude="$currentDirName/client/dist" --exclude="$currentDirName/client/src/editors/node_modules" -zcf $filename $currentDirName echo "Created $currentDirName/release/$filename"