author | Olivier Brunel
<jjk@jjacky.com> 2023-01-10 10:01:11 UTC |
committer | Olivier Brunel
<jjk@jjacky.com> 2023-01-12 19:35:08 UTC |
parent | 4a40e0ad335842f60a0a1d35507787ba03b41ad5 |
.gitignore | +10 | -0 |
AUTHORS | +1 | -0 |
COPYING | +1 | -0 |
HISTORY | +1 | -0 |
Makefile | +15 | -29 |
README | +1 | -0 |
meta/AUTHORS | +2 | -0 |
meta/COPYING | +339 | -0 |
meta/LICENSE | +15 | -0 |
meta/README.git | +50 | -0 |
meta/code | +1 | -0 |
meta/deps-bin | +1 | -0 |
meta/deps/comain/cpnt | +0 | -0 |
meta/deps/comain/git | +1 | -0 |
meta/deps/comain/version | +1 | -0 |
meta/deps/limb/configure | +0 | -0 |
meta/deps/limb/files | +0 | -0 |
meta/deps/limb/git | +1 | -0 |
meta/deps/limb/static | +0 | -0 |
meta/deps/limb/version | +1 | -0 |
meta/deps/md4c/cpnt | +0 | -0 |
meta/deps/md4c/files | +3 | -0 |
meta/deps/md4c/git | +1 | -0 |
meta/deps/md4c/ref | +1 | -0 |
meta/deps/md4c/version | +1 | -0 |
meta/deps/skalibs/get_version | +2 | -0 |
meta/deps/skalibs/git | +1 | -0 |
meta/deps/skalibs/incdir | +1 | -0 |
meta/deps/skalibs/include | +0 | -0 |
meta/deps/skalibs/libdir | +1 | -0 |
meta/deps/skalibs/library | +1 | -0 |
meta/deps/skalibs/ref | +1 | -0 |
meta/deps/skalibs/version | +1 | -0 |
meta/desc | +34 | -0 |
meta/doc | +1 | -0 |
meta/git | +1 | -0 |
meta/options/debug | +1 | -0 |
meta/site | +1 | -0 |
meta/version | +1 | -0 |
project.mk | +10 | -0 |
src/main.c | +1 | -0 |
diff --git a/.gitignore b/.gitignore index c5a02f2..880a41b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,14 @@ +/comain +/configure +/common.mk +/config.mk +/include/config.h /qmdoc /qmdoc.css *.o +*.lo *.d +/md4c +/limb +/limb.built +/skalibs diff --git a/AUTHORS b/AUTHORS new file mode 120000 index 0000000..d66fa36 --- /dev/null +++ b/AUTHORS @@ -0,0 +1 @@ +meta/AUTHORS \ No newline at end of file diff --git a/COPYING b/COPYING new file mode 120000 index 0000000..897d319 --- /dev/null +++ b/COPYING @@ -0,0 +1 @@ +meta/COPYING \ No newline at end of file diff --git a/HISTORY b/HISTORY new file mode 120000 index 0000000..f0c764f --- /dev/null +++ b/HISTORY @@ -0,0 +1 @@ +meta/HISTORY \ No newline at end of file diff --git a/Makefile b/Makefile index ebc15b6..171a535 100644 --- a/Makefile +++ b/Makefile @@ -1,37 +1,23 @@ --include config.mk +# Do *not* edit this file +# Project-specific changes/customization should go into project.mk -SRCS = src/main.c src/md4c.c -OBJS = $(SRCS:.c=.o) -DEPS = $(SRCS:.c=.d) +all: init -CSS = css/struct.css css/common.css css/light.css css/dark.css +init: comain configure common.mk config.mk -BUILD = qmdoc qmdoc.css +configure common.mk: + $(_LN) ln -s comain/$@ $@ +comain: + git clone http://git.lila.oss/comain.git -ifeq ($(DEBUG),1) - CFLAGS = -g -Og -else - CFLAGS = -O3 -endif -CFLAGS += -Wall -isystem ../limb/include -isystem ../skalibs/src/include -LDFLAGS = -L../limb -llimb -L../skalibs -lskarnet +config.mk: | configure common.mk + $(error Please run ./configure to set things up.) +say = @echo " "$1" " +_LN = $(if $(V),,$(call say," LN ")$@;) +_INIT = $(if $(V),,$(call say," INIT ")$@;) -all: $(BUILD) +include common.mk -qmdoc: $(OBJS) - $(CC) $(CFLAGS) $(OBJS) $(LDFLAGS) -o $@ - -qmdoc.css: $(CSS) - cat $(CSS) > $@ - --include $(DEPS) - -%.o: %.c Makefile - $(CC) $(CFLAGS) -MMD -MP -o $@ -c $< - -clean: - rm -f $(BUILD) $(OBJS) $(DEPS) - -$(OBJS): +.PHONY: all init diff --git a/README b/README new file mode 120000 index 0000000..1057430 --- /dev/null +++ b/README @@ -0,0 +1 @@ +meta/README.git \ No newline at end of file diff --git a/meta/AUTHORS b/meta/AUTHORS new file mode 100644 index 0000000..6aef6f1 --- /dev/null +++ b/meta/AUTHORS @@ -0,0 +1,2 @@ +Main author: +* Olivier Brunel <jjk@jjacky.com> diff --git a/meta/COPYING b/meta/COPYING new file mode 100644 index 0000000..a43ea21 --- /dev/null +++ b/meta/COPYING @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 675 Mass Ave, Cambridge, MA 02139, USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + Appendix: How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) 19yy <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) 19yy name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/meta/LICENSE b/meta/LICENSE new file mode 100644 index 0000000..f867b90 --- /dev/null +++ b/meta/LICENSE @@ -0,0 +1,15 @@ +Released under GPL-2.0, see COPYING for more. +Copyright (C) 2023 Olivier Brunel + +This program is free software; you can redistribute it and/or +modify it under the terms of the GNU General Public License +version 2, as published by the Free Software Foundation. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. diff --git a/meta/README.git b/meta/README.git new file mode 100644 index 0000000..a17222c --- /dev/null +++ b/meta/README.git @@ -0,0 +1,50 @@ +If you're reading this, chances are you just cloned the git repository of some +lila software. Congratulations! :) + +Now unlike with the tarball of a release, you're not quite ready to go, there +are a few steps required in order to get things good to go : + +1. First, you need the component *comain* in order to continue. This will + provide scripts and other files needed for configure, etc + + You can simply run `make` to have comain's repo cloned and checked out at + the right version for you. If you'd rather do it yourself, or get a release + tarball, go ahead. + The minimum version needed can be found in meta/deps/comain/version + +2. Once comain is there, if you haven't already you can run `make` to create + needed symlinks such as `configure` or `common.mk` + +3. Good, but there might be other components needed to build this software. + Worry not, comain can help you and set them all up for you. To do so, simply + run `comain/getdeps` + + Each components will then be cloned and checked out as needed. Should you + want to do so manually, you can instead run `comain/getdeps list` and it will + only list all required components and their minimum version. + + By default, in addition to components `comain/getdeps` will also set up + dependencies that are marked to be included in the release tarball. Those are + usually also set to be statically linked, thus providing no runtime + dependency. + + If you do *not* want that, and would like only components to be processed, + simply run `comain/getdeps cpnt` instead. + +4. Now that components are all set up, there might be dependencies as well - + that is, librairies needed to build the software. + + Some dependencies might be classified as "internal", meaning their source + code is included in release tarballs and by default they're linked + statically, thus leading to no runtime dependencies. + Usually, there's only one such dependency, lila's very own `limb` + + If you didn't use `comain/getdeps` on step 3 and now wishes for those to be + setup by comain, you can use `comain/getdeps intdeps` + + You can also use comain to clone repos of *all* dependencies by running + `comain/getdeps alldeps` or pick one and use `comain/getdeps dep NAME` where + `NAME` is to be the name of the dependency to clone the repo of. + +5. That's it, finally you're ready! You can now use `./configure` and `make` as + usual. diff --git a/meta/code b/meta/code new file mode 100644 index 0000000..94719ef --- /dev/null +++ b/meta/code @@ -0,0 +1 @@ +http://git.lila.oss/qmdoc diff --git a/meta/deps-bin b/meta/deps-bin new file mode 100644 index 0000000..83326ea --- /dev/null +++ b/meta/deps-bin @@ -0,0 +1 @@ +qmdoc: src/main.o src/md4c.o limb skalibs diff --git a/meta/deps/comain/cpnt b/meta/deps/comain/cpnt new file mode 100644 index 0000000..e69de29 diff --git a/meta/deps/comain/git b/meta/deps/comain/git new file mode 100644 index 0000000..70bb36e --- /dev/null +++ b/meta/deps/comain/git @@ -0,0 +1 @@ +http://git.lila.oss/comain.git diff --git a/meta/deps/comain/version b/meta/deps/comain/version new file mode 100644 index 0000000..77d6f4c --- /dev/null +++ b/meta/deps/comain/version @@ -0,0 +1 @@ +0.0.0 diff --git a/meta/deps/limb/configure b/meta/deps/limb/configure new file mode 100644 index 0000000..e69de29 diff --git a/meta/deps/limb/files b/meta/deps/limb/files new file mode 100644 index 0000000..e69de29 diff --git a/meta/deps/limb/git b/meta/deps/limb/git new file mode 100644 index 0000000..cd7a82d --- /dev/null +++ b/meta/deps/limb/git @@ -0,0 +1 @@ +http://git.lila.oss/limb.git diff --git a/meta/deps/limb/static b/meta/deps/limb/static new file mode 100644 index 0000000..e69de29 diff --git a/meta/deps/limb/version b/meta/deps/limb/version new file mode 100644 index 0000000..77d6f4c --- /dev/null +++ b/meta/deps/limb/version @@ -0,0 +1 @@ +0.0.0 diff --git a/meta/deps/md4c/cpnt b/meta/deps/md4c/cpnt new file mode 100644 index 0000000..e69de29 diff --git a/meta/deps/md4c/files b/meta/deps/md4c/files new file mode 100644 index 0000000..e465d02 --- /dev/null +++ b/meta/deps/md4c/files @@ -0,0 +1,3 @@ +LICENSE.md +src/md4c.h +src/md4c.c diff --git a/meta/deps/md4c/git b/meta/deps/md4c/git new file mode 100644 index 0000000..744a43f --- /dev/null +++ b/meta/deps/md4c/git @@ -0,0 +1 @@ +http://git.lila.oss/md4c.git diff --git a/meta/deps/md4c/ref b/meta/deps/md4c/ref new file mode 100644 index 0000000..16311d7 --- /dev/null +++ b/meta/deps/md4c/ref @@ -0,0 +1 @@ +lila diff --git a/meta/deps/md4c/version b/meta/deps/md4c/version new file mode 100644 index 0000000..af684dd --- /dev/null +++ b/meta/deps/md4c/version @@ -0,0 +1 @@ +0.4.8.lila.1 diff --git a/meta/deps/skalibs/get_version b/meta/deps/skalibs/get_version new file mode 100755 index 0000000..55041f5 --- /dev/null +++ b/meta/deps/skalibs/get_version @@ -0,0 +1,2 @@ +#!/bin/sh +grep SKALIBS_VERSION "$@/skalibs/config.h" | cut -d\" -f2 diff --git a/meta/deps/skalibs/git b/meta/deps/skalibs/git new file mode 100644 index 0000000..0444f4c --- /dev/null +++ b/meta/deps/skalibs/git @@ -0,0 +1 @@ +http://git.lila.oss/skalibs.git diff --git a/meta/deps/skalibs/incdir b/meta/deps/skalibs/incdir new file mode 100644 index 0000000..e4484e2 --- /dev/null +++ b/meta/deps/skalibs/incdir @@ -0,0 +1 @@ +src/include diff --git a/meta/deps/skalibs/include b/meta/deps/skalibs/include new file mode 100644 index 0000000..e69de29 diff --git a/meta/deps/skalibs/libdir b/meta/deps/skalibs/libdir new file mode 100644 index 0000000..5baacc7 --- /dev/null +++ b/meta/deps/skalibs/libdir @@ -0,0 +1 @@ +skalibs diff --git a/meta/deps/skalibs/library b/meta/deps/skalibs/library new file mode 100644 index 0000000..39971a0 --- /dev/null +++ b/meta/deps/skalibs/library @@ -0,0 +1 @@ +skarnet diff --git a/meta/deps/skalibs/ref b/meta/deps/skalibs/ref new file mode 100644 index 0000000..1f7391f --- /dev/null +++ b/meta/deps/skalibs/ref @@ -0,0 +1 @@ +master diff --git a/meta/deps/skalibs/version b/meta/deps/skalibs/version new file mode 100644 index 0000000..48c7359 --- /dev/null +++ b/meta/deps/skalibs/version @@ -0,0 +1 @@ +2.13.0.0 diff --git a/meta/desc b/meta/desc new file mode 100644 index 0000000..710481e --- /dev/null +++ b/meta/desc @@ -0,0 +1,34 @@ +Quick MarkDown Documentation Generator + +*qmdoc* is a simple, lightweight, fast tool that will convert MarkDown files +into HTML files, with an aim at documentation. + +The generated files are pure HTML/CSS, without any JavaScript. Thus they are +static files that can easily can made available and shared. + +Relying on the [md4c] parser, it is mostly CommonMark compliant - /mostly/, +because it comes with a few (unique) extensions to easy things up. + +For example, the way to set emphasis and other style has been adjusted : +* Text in between stars (e.g. `*foobar*`) will be *bold* +* Text in between slashes (e.g. `/foobar/`) will be /italic/ +* Text in between underscores (e.g. `_foobar_`) will be _underlined_ +* Text in between tildes (e.g. `~foobar~`) will be ~striked~ +* Text in between equal signs (e.g. `=foobar=`) will be =highlighted= + +As expected *qmdoc* supports code blocks, quote blocks, lists, etc as well as +indentation blocks (usefull to write man page-like document) and so-called +boxes to present warnings, information, hints and simply notes. + +It also supports "/man-page links/" - that is links of the form `[foobar](n)` +where `n` is a digit from 1 to 8. Such links will be automatically made to +target a matching page (e.g. `foobar.n.html`) being generated if any, else can +be linked using a specified prefix URL, or simply not made into link. Either +way, the text will be in the form `foobar(n)` as you'd expect. + +*qmdoc* will also generate a Table of Contents for each generated pages, as well +as a global TOC encompassing all generated pages, thusly creating an overall +(customizable) index.html providing the user with the full documentation's TOC. + + +[md4c]: https://github.com/mity/md4c diff --git a/meta/doc b/meta/doc new file mode 100644 index 0000000..53c2a74 --- /dev/null +++ b/meta/doc @@ -0,0 +1 @@ +http://doc.lila.oss/qmdoc diff --git a/meta/git b/meta/git new file mode 100644 index 0000000..6a9b4a5 --- /dev/null +++ b/meta/git @@ -0,0 +1 @@ +http://git.lila.oss/qmdoc.git diff --git a/meta/options/debug b/meta/options/debug new file mode 120000 index 0000000..e1eaa8a --- /dev/null +++ b/meta/options/debug @@ -0,0 +1 @@ +../../comain/meta/options/debug \ No newline at end of file diff --git a/meta/site b/meta/site new file mode 100644 index 0000000..77a8213 --- /dev/null +++ b/meta/site @@ -0,0 +1 @@ +http://lila.oss/qmdoc diff --git a/meta/version b/meta/version new file mode 100644 index 0000000..77d6f4c --- /dev/null +++ b/meta/version @@ -0,0 +1 @@ +0.0.0 diff --git a/project.mk b/project.mk new file mode 100644 index 0000000..63ce618 --- /dev/null +++ b/project.mk @@ -0,0 +1,10 @@ +BINS = qmdoc +CSS = css/struct.css css/common.css css/light.css css/dark.css + +all: qmdoc.css +CLEAN += qmdoc.css + +qmdoc.css: $(CSS) + $(_CSS) cat $(CSS) > $@ + +_CSS = $(if $(V),,$(call say," CSS ")$@;) diff --git a/src/main.c b/src/main.c index 50cc6fe..8c74cca 100644 --- a/src/main.c +++ b/src/main.c @@ -17,6 +17,7 @@ #include <limb/unix-transactional.h> #include "md4c.h" #include "qmdoc.h" +#include "config.h" const char *PROG = "qmdoc";