diff --git a/browser/components/loop/README.txt b/browser/components/loop/README.txt index 2ac0262d621..c0fa663d1ed 100644 --- a/browser/components/loop/README.txt +++ b/browser/components/loop/README.txt @@ -1,12 +1,8 @@ -In order for the loop component to build, run the make-links.sh script to -setup symlinks from the Gecko tree into your loop-client-repo for shared code, -noting that you'll need to put the correct path inside the [[ ]] placeholder -(and remove the [[ ]] characters). +This is the directory for the Loop desktop implementation and the standalone client. -$ export LOOP_CLIENT_REPO=[[/absolute-path/to/my/loop-client-repo/clone]] -$ ./make-links.sh +The desktop implementation is the UX built into Firefox, activated by the Loop button on the toolbar. The standalone client is the link-clicker UX for any modern browser that supports WebRTC. + +The standalone client is a set of web pages intended to be hosted on a standalone server referenced by the loop-server. + +The standalone client exists in standalone/ but shares items (from content/shared/) with the desktop implementation. See the README.md file in the standalone/ directory for how to run the server locally. -Note that changes to the shared directories affect both the standalone -loop-client and the desktop client. This means that sometimes, in order to -make a desktop client patch, you'll need to get reviews on patches to both -mozilla-central/gecko-dev as well as loop-client. diff --git a/browser/components/loop/make-links.sh b/browser/components/loop/make-links.sh deleted file mode 100755 index 6127b66bf8f..00000000000 --- a/browser/components/loop/make-links.sh +++ /dev/null @@ -1,25 +0,0 @@ -#!/bin/bash - -if [ `basename $PWD` != "loop" ]; then - echo "this script must be executed in the loop directory" - exit -1 -fi - -if [ ! -d "$LOOP_CLIENT_REPO" ]; then - echo "LOOP_CLIENT_REPO in the environment must be set to a valid directory" - exit -1 -fi - -SHARED_CONTENT_TARGET=./content/shared -rm -f ${SHARED_CONTENT_TARGET} - -SHARED_CONTENT=${LOOP_CLIENT_REPO}/content/shared -ln -s ${SHARED_CONTENT} ${SHARED_CONTENT_TARGET} - -SHARED_TEST_TARGET=./test/shared -rm -f ${SHARED_TEST_TARGET} - -SHARED_TEST=${LOOP_CLIENT_REPO}/test/shared -ln -s ${SHARED_TEST} ${SHARED_TEST_TARGET} - -