greenwich - Make a more useful readme
authorTim Otten <totten@civicrm.org>
Mon, 14 Sep 2020 07:24:43 +0000 (00:24 -0700)
committerTim Otten <totten@civicrm.org>
Thu, 17 Sep 2020 02:54:06 +0000 (19:54 -0700)
ext/greenwich/README.md
ext/greenwich/images/screenshot.png [deleted file]

index 5e92b2e2d93f0222078fb2dfa548decf4b93c4de..c72c25d12df686a2d0384e772bf5c33f0bedaeb0 100644 (file)
@@ -1,44 +1,20 @@
 # greenwich
 
-![Screenshot](/images/screenshot.png)
+The `greenwich` theme-extension is bundled into `civicrm-core`.
 
-(*FIXME: In one or two paragraphs, describe what the extension does and why one would download it. *)
+## Development
 
-The extension is licensed under [AGPL-3.0](LICENSE.txt).
+This extension includes compiled (S)CSS content. It is compiled automatically via `composer`.
+Compiled files should *not* be committed to git. They will be generated during `composer install`.
 
-## Requirements
-
-* PHP v7.0+
-* CiviCRM (*FIXME: Version number*)
-
-## Installation (Web UI)
-
-This extension has not yet been published for installation via the web UI.
-
-## Installation (CLI, Zip)
-
-Sysadmins and developers may download the `.zip` file for this extension and
-install it with the command-line tool [cv](https://github.com/civicrm/cv).
+These commands will help during development:
 
 ```bash
-cd <extension-dir>
-cv dl greenwich@https://github.com/FIXME/greenwich/archive/master.zip
-```
+cd /path/to/my/composer/root
 
-## Installation (CLI, Git)
+## Compile (S)CSS - one time
+composer compile
 
-Sysadmins and developers may clone the [Git](https://en.wikipedia.org/wiki/Git) repo for this extension and
-install it with the command-line tool [cv](https://github.com/civicrm/cv).
-
-```bash
-git clone https://github.com/FIXME/greenwich.git
-cv en greenwich
+## Compile (S)CSS - and continue watching for changes
+composer compile:watch
 ```
-
-## Usage
-
-(* FIXME: Where would a new user navigate to get started? What changes would they see? *)
-
-## Known Issues
-
-(* FIXME *)
diff --git a/ext/greenwich/images/screenshot.png b/ext/greenwich/images/screenshot.png
deleted file mode 100644 (file)
index 6765b69..0000000
Binary files a/ext/greenwich/images/screenshot.png and /dev/null differ