target/ccsdisk/files/README

   1                     ____  _____  ____
   2   _ _ _            |  __||     ||  __|
   3  | (_) |__ _ _ ___ | |   | | | || |
   4  | | | '_ \ '_/ -_)| |__ | | | || |__
   5  |_|_|_.__/_| \___||____||_|_|_||____|
   6  -----------------------------------------
   7   The libre embedded GNU/Linux distro.
   8
   9 This compact disk contains the source code and firmware images
  10 for the %T line of routers.
  11
  12
  13 Disk Layout:
  14 ============================
  15
  16 /bin/%T/*                               : Contains firmware images for %T family of routers
  17
  18
  19 libreCMC-%V-src.tar.gz          : The full libreCMC source code w/ original configuration.
  20
  21
  22 Building libreCMC image from source:
  23 ============================
  24
  25 To build your own firmware, you need to have access to a GNU/Linux system
  26 (case-sensitive filesystem required) with the following installed :
  27
  28 gcc, binutils, bzip2, flex, python, perl, make, find,
  29 grep, diff, unzip, gawk, getopt, libssl-dev (openssl-devel), libz-dev and libc headers.
  30
  31 References to this and other documentation use : "$LIBRECMC_SRC" , which
  32 is the directory where the libreCMC source code resides.
  33
  34 Before starting, please extract : libreCMC-%V.tar.gz
  35
  36 tar fxv librecmc-%V.tar.gz
  37
  38 cd libreCMC/
  39
  40 Within the libreCMC src. directory (in this case, trunk), please use "make menuconfig" to create your
  41 desired configuration for the toolchain and firmware. Please note that the default configuration is
  42 what was used to build the firmware image for your router. It is advised that you use this configuration. If
  43 you need to restore the default configuration, copy librecmc_config to libreCMC/trunk/.config
  44
  45 Simply running "make" will build your firmware. The build system will extract all included sources,
  46 build the cross-compile toolchain, the kernel and all chosen applications. If there is an issue, please run:
  47
  48 make V=s
  49
  50 This will show debugging output and give a clue as to why the build failed.
  51
  52 When the build completes without any issues, the resulting librecmc-ar71xx-generic-tpe-r1100-squashfs-sysupgrade.bin image will
  53 be found in : $SRC_ROOT/bin/targets/ar71xx/
  54
  55 Flashing The libreCMC firmware
  56 ============================
  57
  58 1) Open a web browser and go to : https://192.168.10.1
  59
  60 2) You will see a security warning because SSL cert is self-
  61 signed. Click the "understand the risks" and then "add exception" buttons.
  62
  63 3) Enter the admin password for the router (stock password is : none )
  64
  65 4) The backup / flash utility is under "System -> Backup / Flash Firmware".
  66
  67 5) Make sure to backup your configuration (if you are upgrading to a new release)
  68 by clicking the "Generate archive" button. This will download a file named
  69 backup-libreCMC-$(DATE).tar.gz
  70
  71 6) Upload the new firmware by clicking the "browse" button under "Flash new firmware image".
  72 If you wish to keep your current settings, make sure that the "Keep Settings" checkbox is
  73 checked. If the file name is correct, make sure to click the "Flash Image" button.
  74
  75 7) Wait a about 1 - 2.5 min. The router will restart itself then the page should refresh, bringing
  76 you back to the login page.
  77
  78
  79 Final Words
  80 ============================
  81
  82 We would like to thank you for supporting the libreCMC project. If you find any
  83 software in this release that is non-free software, please report it to info@librecmc.org.
  84 We will review the offending piece of software and devise a workaround or patch.
  85 libreCMC aims to always be a 100% libre Free Software project.
  86
  87
  88 Happy Hacking,
  89
  90         Your libreCMC Project
  91         http://librecmc.org
  92         info@librecmc.org
  93
  94