Merge pull request #3543 from donaldsharp/eigrp_router_id_is_the_bee

[mirror_frr.git] / snapcraft / README.snap_build.md

diff --git a/snapcraft/README.snap_build.md b/snapcraft/README.snap_build.md
index 341b210f71e2e044beffd6401e93fa7c99769c5b..7c4284845183256709ed42dad2cea83ee422ab8a 100644 (file)
--- a/snapcraft/README.snap_build.md
+++ b/snapcraft/README.snap_build.md
@@ -1,4 +1,4 @@
-Building your own FreeRangeRouting Snap
+Building your own FRRouting Snap
 ========================================
 (Tested on Ubuntu 16.04 with Snap Version 2, does not work on Ubuntu 15.x
 which uses earlier versions of snaps)
@@ -7,12 +7,17 @@ which uses earlier versions of snaps)
 
         sudo apt-get install snapcraft
        
-2. Checkout FreeRangeRouting under a **unpriviledged** user account
+2. Checkout FRRouting under a **unpriviledged** user account
 
-        git clone https://github.com/freerangerouting/frr.git
+        git clone https://github.com/frrouting/frr.git
         cd frr
 
-3. Run Bootstrap and make distribution tar.gz
+3. (Optional) Add extra version information to 
+   `snapcraft/extra_version_info.txt`. Information in this file will
+   be displayed with the frr.version command (simple `cat` after
+   the display of the `zebra --version` output)
+
+4. Run Bootstrap and make distribution tar.gz
 
         ./bootstrap.sh
         ./configure --with-pkg-extra-version=-MySnapVersion
@@ -25,7 +30,7 @@ which uses earlier versions of snaps)
     This will build `frr-something.tar.gz` - the distribution tar and 
     the snapcraft/snapcraft.yaml with the matching version number
 
-4. Create snap
+5. Create snap
 
         cd snapcraft
         snapcraft
@@ -47,8 +52,10 @@ Installing the snap
 
     Connect the priviledged `network-control` plug to the snap:
 
-        snap connect frr:network-control ubuntu-core:network-control
+        snap connect frr:network-control core:network-control
 
+See README.usage.md for more details on setting up and using the snap
+        
 DONE.
 
 The Snap will be auto-started and running. 
@@ -56,8 +63,8 @@ The Snap will be auto-started and running.
 Operations
 ==========
 
-### FreeRangeRouting Daemons
-At this time, all FreeRangeRouting daemons are auto-started.
+### FRRouting Daemons
+At this time, all FRRouting daemons are auto-started.
 
 A daemon can be stopped/started with (ie ospf6d)
 
@@ -69,7 +76,7 @@ or disabled/enabled with
     systemctl disable snap.frr.ospf6d.service
     systemctl enable snap.frr.ospf6d.service
 
-### FreeRangeRouting Commands
+### FRRouting Commands
 All the commands are prefixed with frr.
 
     frr.vtysh       -> vtysh
@@ -87,7 +94,16 @@ All the commands are prefixed with frr.
     frr.zebra-debug
 
 vtysh can be accessed as frr.vtysh (Make sure you have /snap/bin in your
-path). If access as `vtysh` instead of `frr.vtysh` is needed, a symlink 
-can be created:
+path). If access as `vtysh` instead of `frr.vtysh` is needed, you can enable it
+via a snap alias as follows:
+
+   sudo snap alias frr vtysh
+
+This will add the vtysh command to your /snap/bin for direct access. The output of
+
+   sudo snap aliases
+
+should list vtysh command alias as enabled:
 
-    sudo ln -s /snap/bin/frr.vtysh /usr/local/bin/vtysh
+App          Alias    Notes
+frr.vtysh    vtysh    enabled