Skip to content

Commit

Permalink
Docs: Add development section
Browse files Browse the repository at this point in the history
  • Loading branch information
alphapapa committed Feb 22, 2024
1 parent f5cda3d commit e41fe90
Show file tree
Hide file tree
Showing 2 changed files with 126 additions and 83 deletions.
9 changes: 9 additions & 0 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ It includes three libraries: The =org-ql= library is flexible and may be used as
- [[#installation][Installation]]
- [[#usage][Usage]]
- [[#changelog][Changelog]]
- [[#development][Development]]
:END:


Expand Down Expand Up @@ -949,6 +950,14 @@ Nothing new yet.

First tagged release.

* Development

Bug reports, feature requests, and suggestions are welcome. For patches, see below.

** Copyright assignment

While Org QL is currently distributed in MELPA, it's [[https://github.com/alphapapa/org-ql/issues/409][intended]] to merge Org QL into Org mode. When that happens, it will become a part of Emacs and Org, and therefore cumulative contributions of more than 15 lines of code will require that the author assign copyright of such contributions to the FSF. Authors who are interested in doing so may contact [[mailto:[email protected]][[email protected]]] to request the appropriate form.

* Notes
:PROPERTIES:
:TOC: :ignore this
Expand Down
200 changes: 117 additions & 83 deletions org-ql.info
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ and saved views.
* Installation::
* Usage::
* Changelog::
* Development::
* Notes::
* License::

Expand Down Expand Up @@ -110,6 +111,10 @@ Changelog
* 0.2: 02.
* 0.1: 01.

Development

* Copyright assignment::

Notes

* Comparison with Org Agenda searches::
Expand All @@ -122,7 +127,7 @@ File: README.info, Node: Contents, Next: Screenshots, Prev: Top, Up: Top
1 Contents
**********

• • • •
• • • •

File: README.info, Node: Screenshots, Next: Installation, Prev: Contents, Up: Top

Expand Down Expand Up @@ -1021,7 +1026,7 @@ File: README.info, Node: Tips, Prev: Links, Up: Usage
(https://github.com/alphapapa/burly.el).


File: README.info, Node: Changelog, Next: Notes, Prev: Usage, Up: Top
File: README.info, Node: Changelog, Next: Development, Prev: Usage, Up: Top

5 Changelog
***********
Expand Down Expand Up @@ -1910,9 +1915,36 @@ File: README.info, Node: 01, Prev: 02, Up: Changelog
First tagged release.


File: README.info, Node: Notes, Next: License, Prev: Changelog, Up: Top
File: README.info, Node: Development, Next: Notes, Prev: Changelog, Up: Top

6 Development
*************

Bug reports, feature requests, and suggestions are welcome. For
patches, see below.

* Menu:

* Copyright assignment::


File: README.info, Node: Copyright assignment, Up: Development

6.1 Copyright assignment
========================

While Org QL is currently distributed in MELPA, it’s intended
(https://github.com/alphapapa/org-ql/issues/409) to merge Org QL into
Org mode. When that happens, it will become a part of Emacs and Org,
and therefore cumulative contributions of more than 15 lines of code
will require that the author assign copyright of such contributions to
the FSF. Authors who are interested in doing so may contact
[email protected] <[email protected]> to request the appropriate form.


File: README.info, Node: Notes, Next: License, Prev: Development, Up: Top

6 Notes
7 Notes
*******

* Menu:
Expand All @@ -1923,7 +1955,7 @@ File: README.info, Node: Notes, Next: License, Prev: Changelog, Up: Top

File: README.info, Node: Comparison with Org Agenda searches, Next: org-sidebar, Up: Notes

6.1 Comparison with Org Agenda searches
7.1 Comparison with Org Agenda searches
=======================================

Of course, queries like these can already be written with Org Agenda
Expand All @@ -1943,7 +1975,7 @@ todo:TO-READ’, or in Lisp syntax, ‘(and "lisp" (todo "TO-READ"))’.

File: README.info, Node: org-sidebar, Prev: Comparison with Org Agenda searches, Up: Notes

6.2 org-sidebar
7.2 org-sidebar
===============

This package is used by org-sidebar
Expand All @@ -1953,7 +1985,7 @@ customizable agenda-like view in a sidebar window.

File: README.info, Node: License, Prev: Notes, Up: Top

7 License
8 License
*********

GPLv3
Expand All @@ -1962,82 +1994,84 @@ GPLv3

Tag Table:
Node: Top225
Node: Contents1940
Node: Screenshots2063
Node: Installation2181
Node: Quelpa2695
Node: Helm support3223
Node: Usage3626
Node: Commands4024
Node: org-ql-find4489
Node: org-ql-open-link5397
Node: org-ql-refile6252
Node: org-ql-search6580
Node: helm-org-ql8511
Node: org-ql-view8889
Node: org-ql-view-sidebar9419
Node: org-ql-view-recent-items9799
Node: org-ql-sparse-tree10295
Node: Queries11095
Node: Non-sexp query syntax12212
Node: General predicates13971
Node: Ancestor/descendant predicates20896
Node: Date/time predicates22024
Node: Functions / Macros25148
Node: Agenda-like views25446
Ref: Function org-ql-block25608
Node: Listing / acting-on results26869
Ref: Caching27077
Ref: Function org-ql-select27990
Ref: Function org-ql-query30416
Ref: Macro org-ql (deprecated)32190
Node: Custom predicates32505
Ref: Macro org-ql-defpred32729
Node: Dynamic block36170
Node: Links38894
Node: Tips39581
Node: Changelog39905
Node: 09-pre40810
Node: 08540917
Node: 08441576
Node: 08342028
Node: 08242369
Node: 08142762
Node: 0843183
Node: 07445907
Node: 07346130
Node: 07246862
Node: 07147783
Node: 0748594
Node: 06351460
Node: 06251993
Node: 06152300
Node: 0652870
Node: 05255926
Node: 05156228
Node: 0556653
Node: 04958184
Node: 04858466
Node: 04758815
Node: 04659224
Node: 04559632
Node: 04459993
Node: 04360352
Node: 04260555
Node: 04160716
Node: 0460963
Node: 03265064
Node: 03165467
Node: 0365664
Node: 02368964
Node: 02269198
Node: 02169478
Node: 0269683
Node: 0173761
Node: Notes73862
Node: Comparison with Org Agenda searches74024
Node: org-sidebar74913
Node: License75192
Node: Contents1995
Node: Screenshots2122
Node: Installation2240
Node: Quelpa2754
Node: Helm support3282
Node: Usage3685
Node: Commands4083
Node: org-ql-find4548
Node: org-ql-open-link5456
Node: org-ql-refile6311
Node: org-ql-search6639
Node: helm-org-ql8570
Node: org-ql-view8948
Node: org-ql-view-sidebar9478
Node: org-ql-view-recent-items9858
Node: org-ql-sparse-tree10354
Node: Queries11154
Node: Non-sexp query syntax12271
Node: General predicates14030
Node: Ancestor/descendant predicates20955
Node: Date/time predicates22083
Node: Functions / Macros25207
Node: Agenda-like views25505
Ref: Function org-ql-block25667
Node: Listing / acting-on results26928
Ref: Caching27136
Ref: Function org-ql-select28049
Ref: Function org-ql-query30475
Ref: Macro org-ql (deprecated)32249
Node: Custom predicates32564
Ref: Macro org-ql-defpred32788
Node: Dynamic block36229
Node: Links38953
Node: Tips39640
Node: Changelog39964
Node: 09-pre40875
Node: 08540982
Node: 08441641
Node: 08342093
Node: 08242434
Node: 08142827
Node: 0843248
Node: 07445972
Node: 07346195
Node: 07246927
Node: 07147848
Node: 0748659
Node: 06351525
Node: 06252058
Node: 06152365
Node: 0652935
Node: 05255991
Node: 05156293
Node: 0556718
Node: 04958249
Node: 04858531
Node: 04758880
Node: 04659289
Node: 04559697
Node: 04460058
Node: 04360417
Node: 04260620
Node: 04160781
Node: 0461028
Node: 03265129
Node: 03165532
Node: 0365729
Node: 02369029
Node: 02269263
Node: 02169543
Node: 0269748
Node: 0173826
Node: Development73927
Node: Copyright assignment74160
Node: Notes74750
Node: Comparison with Org Agenda searches74914
Node: org-sidebar75803
Node: License76082

End Tag Table

Expand Down

0 comments on commit e41fe90

Please sign in to comment.