Add README to ./bin

deanishe · Apr 30, 2017 · c7b9019 · c7b9019
1 parent c7945e2
commit c7b9019
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 10 deletions.
diff --git a/bin/README.md b/bin/README.md
@@ -0,0 +1,14 @@
+
+bin
+===
+
+Scripts for building and publishing Alfred-Workflow.
+
+- `build-workflow.sh` — Build the distributable workflow as `workflow-1.n.n.zip` in the project root directory.
+- `publish-cheeseshop.sh` — Build the distribution and publish on PyPi.
+- `build-dash-docset.sh` — Build a docset for [Dash][dash] in `docs/` from HTML docs.
+- `build-docs.sh` — Generate HTML docs in `docs/_build/html/`. You must run this before running `build-dash-docset.sh`.
+- `publish-docs.sh` — Build the docs and push them to `gh-pages` / http://www.deanishe.net/alfred-workflow/
+- `testone` — Run test script(s) with coverage for one module/package.
+
+[dash]: https://kapeli.com/dash
diff --git a/extras/testone → bin/testone b/extras/testone → bin/testone
diff --git a/extras/README.md b/extras/README.md
@@ -5,25 +5,19 @@ Extras
 Helper scripts, icons and other stuff.
 
 
-Build & distribution
---------------------
+Components
+----------
 
-- `build-workflow.sh` — Build the distributable workflow as `workflow-1.n.n.zip` in the project root directory.
 - `Notify.app` — AppleScript application to post notifications.
 - `Notify.tgz` — The app compressed for distribution.
-- `publish-cheeseshop.sh` — Build the distribution and publish on PyPi.
-- `testone` — Run test script(s) with coverage for one module/package.
 
 
 Docs
 ----
 
-- `build-dash-docset.sh` — Build a docset for [Dash][dash] in `docs/` from HTML docs.
-- `build-docs.sh` — Generate HTML docs in `docs/_build/html/`. You must run this before running `build-dash-docset.sh`.
 - `gen_icon_table.py` — Generate the ReST table of system icons for the User Manual. Also generates PNGs in the `docs/_static/` directory.
 - `generate_workflow_list.py` — Generate a Markdown/ReST list of workflows based on Alfred-Workflow from the Packal repository.
 - `library_workflows.tsv` — Non-Packal workflows to include in the workflow list.
-- `publish-docs.sh` — Build the docs and push them to `gh-pages` / http://www.deanishe.net/alfred-workflow/
 
 
 Icons
@@ -36,5 +30,3 @@ Icons
 	- `Alfred-Workflow.png` — Generated Alfred-Workflow icon.
 	- `Alfred-Workflow.sketch` — Alfred-Workflow icon source file.
 
-
-[dash]: https://kapeli.com/dash