ext/afform/html/README.md

   1 # org.civicrm.afform-html
   2
   3 ![Screenshot](/images/screenshot.png)
   4
   5 This extension provides a UI for overriding the html in a flexible form. The UI  is accessible at the url civicrm/admin/afform-html
   6
   7 The extension is licensed under [AGPL-3.0](LICENSE.txt).
   8
   9 ## Requirements
  10
  11 * PHP v5.6+
  12 * CiviCRM (*FIXME: Version number*)
  13
  14 ## Installation (Web UI)
  15
  16 This extension has not yet been published for installation via the web UI.
  17
  18 ## Installation (CLI, Zip)
  19
  20 Sysadmins and developers may download the `.zip` file for this extension and
  21 install it with the command-line tool [cv](https://github.com/civicrm/cv).
  22
  23 ```bash
  24 cd <extension-dir>
  25 cv dl org.civicrm.afform-html@https://github.com/FIXME/org.civicrm.afform-html/archive/master.zip
  26 ```
  27
  28 ## Installation (CLI, Git)
  29
  30 Sysadmins and developers may clone the [Git](https://en.wikipedia.org/wiki/Git) repo for this extension and
  31 install it with the command-line tool [cv](https://github.com/civicrm/cv).
  32
  33 ```bash
  34 git clone https://github.com/FIXME/org.civicrm.afform-html.git
  35 cv en afform_html
  36 ```
  37
  38 ## Usage
  39
  40 (* FIXME: Where would a new user navigate to get started? What changes would they see? *)
  41
  42 ## Known Issues
  43
  44 (* FIXME *)