Skip to content
This repository has been archived by the owner on Apr 21, 2019. It is now read-only.

Commit

Permalink
fix(Deploy): fixed package script, updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Maja Nedeljković committed Apr 26, 2016
1 parent 5f903ec commit f213052
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion cli/pack.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down

0 comments on commit f213052

Please sign in to comment.