Merge pull request #1079 from ethereum/LianaHus-lower-case

changed RemixD's to `remixd`
pull/5370/head
yann300 6 years ago committed by GitHub
commit 78b34a7fec
  1. 16
      docs/tutorial_remixd_filesystem.md

@ -1,32 +1,32 @@
Access your local filesystem by using RemixD Access your local filesystem by using remixd
=================================================== ===================================================
RemixD is an npm module. Its purpose is to give the remix web `remixd` is an npm module. Its purpose is to give the remix web
application access to a folder from your local computer. application access to a folder from your local computer.
The code of RemixD can be checked out The code of `remixd` can be checked out
[here](https://github.com/ethereum/remixd) . [here](https://github.com/ethereum/remixd) .
Remixd can be globally installed using the following command: `remixd` can be globally installed using the following command:
`npm install -g remixd`. `npm install -g remixd`.
Then `remixd -s <absolute-path-to-the-shared-folder> --remix-ide <your-remix-ide-URL-instance>` will start Remixd Then `remixd -s <absolute-path-to-the-shared-folder> --remix-ide <your-remix-ide-URL-instance>` will start `remixd`
and share the given folder. and share the given folder.
For example, to sync your local folder to the official Remix IDE, For example, to sync your local folder to the official Remix IDE,
`remixd -s <absolute-path-to-the-shared-folder> --remix-ide https://remix.ethereum.org` `remixd -s <absolute-path-to-the-shared-folder> --remix-ide https://remix.ethereum.org`
The folder is shared using a websocket connection between `Remix IDE` The folder is shared using a websocket connection between `Remix IDE`
and `Remixd`. and `remixd`.
Be sure the user executing Remixd has read/write permission on the Be sure the user executing `remixd` has read/write permission on the
folder. folder.
There is an option to run remixd in read-only mode, use `--read-only` flag. There is an option to run remixd in read-only mode, use `--read-only` flag.
**Warning!** **Warning!**
RemixD provides `full read and write access` to the given folder for `any `remixd` provides `full read and write access` to the given folder for `any
application` that can access the `TCP port 65520` on your local host. application` that can access the `TCP port 65520` on your local host.
From `Remix IDE`, you will need to activate the connection. From `Remix IDE`, you will need to activate the connection.

Loading…
Cancel
Save