diff options
author | elijah <elijah@riseup.net> | 2016-03-04 12:31:20 -0800 |
---|---|---|
committer | elijah <elijah@riseup.net> | 2016-03-04 12:31:20 -0800 |
commit | 63e6d2e63a63a3e81a07b03d6da1bcb459213201 (patch) | |
tree | 7d00f6f044c56e7df75a95e4a4d3f221c5620283 /pages/docs/platform/details/development.md | |
parent | 2b139e15d408e0bd3c2d4c0801ecc3f0bb8744d6 (diff) |
updated quick start tutorials and added a 'getting started' page.
Diffstat (limited to 'pages/docs/platform/details/development.md')
-rw-r--r-- | pages/docs/platform/details/development.md | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/pages/docs/platform/details/development.md b/pages/docs/platform/details/development.md new file mode 100644 index 0000000..78915ad --- /dev/null +++ b/pages/docs/platform/details/development.md @@ -0,0 +1,78 @@ +@title = 'Development' +@summary = "Getting started with making changes to the LEAP platform" + +Installing leap_cli +------------------------------------------------ + +### From gem, for a single user + +Install the latest: + + gem install leap_cli --install-dir ~/leap + export PATH=$PATH:~/leap/bin + +Install a particular version: + + gem install leap_cli --version 1.8 --install-dir ~/leap + export PATH=$PATH:~/leap/bin + +### From gem, system wide + +Install the latest: + + sudo gem install leap_cli + +Install a particular version: + + sudo gem install leap_cli --version 1.8 + +### As a gem, built from source + + sudo apt-get install ruby ruby-dev rake + git clone https://leap.se/git/leap_cli.git + cd leap_cli + git checkout develop + rake build + sudo rake install + +### The "develop" branch from source, for a single user + + sudo apt-get install ruby ruby-dev rake + git clone https://leap.se/git/leap_cli.git + cd leap_cli + git checkout develop + +Then do one of the following to be able to run `leap` command: + + cd leap_cli + export PATH=$PATH:`pwd`/bin + alias leap="`pwd`/bin/leap" + ln -s `pwd`/bin/leap ~/bin/leap + +In practice, of course, you would put aliases or PATH modifications in a shell startup file. + +You can also clone from https://github.com/leap/leap_cli + +Running different leap_cli versions +--------------------------------------------- + +### If installed as a gem + +With rubygems, you can always specify the gem version as the first argument to any executable installed by rubygems. For example: + + sudo gem install leap_cli --version 1.7.2 + sudo gem install leap_cli --version 1.8 + leap _1.7.2_ --version + => leap 1.7.2, ruby 2.1.2 + leap _1.8_ --version + => leap 1.8, ruby 2.1.2 + +### If running from source + +Alternately, if you are running from source, you can alias different commands: + + git clone https://leap.se/git/leap_cli.git + cd leap_cli + git checkout develop + alias leap_develop="`pwd`/bin/leap` + |