aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSander Vrijders <sander.vrijders@ugent.be>2017-04-20 12:53:08 +0200
committerSander Vrijders <sander.vrijders@ugent.be>2017-04-20 12:53:08 +0200
commit925ea3f4380ecdf73f46b86ddef4cb1e3cd84a1b (patch)
tree34ee6b76ee2875dcf1a592bcecac1e7467a82e3d /README.md
parente267e15430f3c2f05b7ff3ffc45f92621518f1e9 (diff)
downloadrumba-925ea3f4380ecdf73f46b86ddef4cb1e3cd84a1b.tar.gz
rumba-925ea3f4380ecdf73f46b86ddef4cb1e3cd84a1b.zip
Update README.md
This fixes some typos in the README
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 19 insertions, 18 deletions
diff --git a/README.md b/README.md
index c2c650d..5d46e5e 100644
--- a/README.md
+++ b/README.md
@@ -18,23 +18,23 @@ a look at the examples/ folder.
3. user creates an instance of prototype.Experiment class, passing
the testbed instance and a list of Node instances
- * At the end of the base Experiment constructor, the
- generate function is called to generate information about
- per-node IPCPs, registrations and enrollment, ready to be
- used by the plugins
+ * At the end of the base Experiment constructor, the
+ generate function is called to generate information about
+ per-node IPCPs, registrations and enrollment, ready to be
+ used by the plugins
4. user calls run() on the prototype.Experiment instance:
- * First, run() calls Testbed.swap_in(), passing the
- Experiment, and filling in the missing information
+ * First, run() calls Testbed.swap_in(), passing the
+ Experiment, and filling in the missing information
- * Second, run() calls a prototype-specific setup function,
- to create the required IPCPs, perform registrations,
- enrollments, etc.
+ * Second, run() calls a prototype-specific setup function,
+ to create the required IPCPs, perform registrations,
+ enrollments, etc.
- * Third, perform tests (TODO)
+ * Third, perform tests (TODO)
- * Fourth, run() calls Testbed.swap_out()
+ * Fourth, run() calls Testbed.swap_out()
## Installation
@@ -72,7 +72,7 @@ a look at the examples/ folder.
In order to use the jFed testbed, a user first needs to download
his/her key from
- [https://authority.ilabt.iminds.be/](https://www.youtube.com/watch?v=dQw4w9WgXcQ/)
+ [https://authority.ilabt.iminds.be/](https://authority.ilabt.iminds.be/)
After logging in, click on *Download your certificate*. Save the
contents in a file (for example cert.pem). A jFed testbed instance
is defined as follows:
@@ -83,15 +83,16 @@ a look at the examples/ folder.
Here the experiment name is rochefort10, the user's name is
ricksanchez, and the certificate can be found in
- /home/morty/cert.pem.
+ /home/morty/cert.pem. Please use an absolute path for cert_file for
+ now.
Before running the experiment it is wise to use an SSH agent to
avoid having to enter the passphrase for every login to a node by
- the framework. (Apart from asking for the passphrase to login to
- the nodes, the framework will always ask for the passphrase since
- it is needed by the jFed CLI as well.) In order to start an SSH
- agent and to add the certificate, simply perform the following
- commands:
+ the framework if you are not on an IPv6 enabled network. (Apart
+ from asking for the passphrase to login to the nodes, the framework
+ will always ask for the passphrase since it is needed by the jFed
+ CLI as well.) In order to start an SSH agent and to add the
+ certificate, simply perform the following commands:
eval `ssh-agent`
ssh-add /home/morty/cert.pem