systems: web: Re-enable co-op repl with simple http server
[8sync.git] / doc / 8sync.texi
index cd265c64671121cc021588215c83ed41647dee42..ae3baed7a162e4f7d8fb885e85a206c3c342f804 100644 (file)
@@ -56,10 +56,17 @@ Foundation Web site at @url{http://www.gnu.org/licenses/lgpl.html}.
 @menu
 * Introduction::
 * Acknowledgements::
+* 8sync's license and general comments on copyleft::
+* Installation::
+* Getting started::
+* API Reference::
+* Contributing::
 * Copying This Manual::
 * Index::
 @end menu
 
+\f
+
 @node Introduction
 @chapter Introduction
 
@@ -84,6 +91,8 @@ Because of this, you can invoke your asynchronous code with a small wrapper
 
 Now that's pretty cool!
 
+\f
+
 @node Acknowledgements
 @chapter Acknowledgements
 
@@ -132,6 +141,7 @@ The motivation to build 8sync came out of
 
 A little over a month after that, hacking on 8sync began!
 
+\f
 
 @node 8sync's license and general comments on copyleft
 @chapter 8sync's license and general comments on copyleft
@@ -150,17 +160,30 @@ In general, it is best to contribute them back to 8sync under the same terms;
   for the precise terms.)
 
 This usage of the LGPL helps us ensure that 8sync and derivatives of
-8sync as a library will remain free.
+  8sync as a library will remain free.
 Though it is not a requirement, we request you use 8sync to build free
   software rather than use it to contribute to the growing world of
   proprietary software.
 
-The choice of the LGPL for 8sync was a strategic one, though in general,
-  we encourage stronger copyleft.
+The choice of the LGPL for 8sync was a strategic one.
+This is not a general recommendation to use the LGPL instead of the GPL
+  for all libraries.
+In general, we encourage stronger copyleft.
 (For more thinking on this position, see
   @uref{https://www.gnu.org/licenses/why-not-lgpl.html,
         Why you shouldn't use the Lesser GPL for your next library}.)
 
+Although 8sync provides some unique features, its main functionality is as
+  an asynchronous event loop, and there are many other asynchronous event
+  loop systems out there such as Node.js for Javascript and Asyncio for
+  Python (there are others as well).
+It is popular in some of these communities to hold anti-copyleft positions,
+  which is unfortunate, and many community members seem to be adopting
+  these positions because other developers they look up to are holding
+  them.
+If you have come from one of these communities and are exploring 8sync, we
+  hope reading this will help you reconsider your position.
+
 In particular, if you are building a library or application that uses
   8sync in some useful way, consider releasing your program under the GNU
   GPL or GNU AGPL!
@@ -176,6 +199,30 @@ So to answer the question, ``Can I build a proprietary program on top of
     And help us turn the tide towards greater software freedom...
       consider a strong copyleft license!''
 
+\f
+
+@node Installation
+@chapter Installation
+
+General GNU configure / make / make install instructions go here!
+:)
+
+\f
+
+@node Getting started
+@chapter Getting started
+
+\f
+
+@node API Reference
+@chapter API Reference
+
+\f
+
+@node Contributing
+@chapter Contributing
+
+\f
 
 @node Copying This Manual
 @appendix Copying This Manual
@@ -185,6 +232,8 @@ no invariant sections.  At your option, it is also available under the
 GNU Lesser General Public License, as published by the Free Software
 Foundation, version 3 or any later version.
 
+\f
+
 @menu
 * GNU Free Documentation License::  License for copying this manual.
 @end menu