]> Cypherpunks.ru repositories - goredo.git/blobdiff - doc/index.texi
Thanks to Kai Hendry for AUR port and bugreports
[goredo.git] / doc / index.texi
diff --git a/doc/index.texi b/doc/index.texi
new file mode 100644 (file)
index 0000000..3a8c786
--- /dev/null
@@ -0,0 +1,54 @@
+\input texinfo
+@documentencoding UTF-8
+@settitle goredo
+
+@copying
+Copyright @copyright{} 2020-2021 @email{stargrave@@stargrave.org, Sergey Matveev}
+@end copying
+
+@node Top
+@top
+
+This is pure Go implementation of @url{http://cr.yp.to/redo.html, DJB's
+redo} build system proposal. Originally it was just a rewrite of
+@url{https://github.com/leahneukirchen/redo-c, redo-c}, but later most
+features of @url{https://redo.readthedocs.io/en/latest/, apenwarr/redo}
+were also implemented. Why yet another implementation? It is feature
+full and has better performance comparing to shell and Python
+implementation.
+
+It passes tests from
+@url{http://news.dieweltistgarnichtso.net/bin/redo-sh.html, redo-sh.tests}
+and implementation-neutral ones from @command{apenwarr/redo}.
+
+If you are not familiar with the redo, then here are advisable links to read:
+
+@itemize
+@item @url{https://redo.readthedocs.io/en/latest/, apenwarr/redo documentation}
+@item @url{http://jdebp.eu/FGA/introduction-to-redo.html, Introduction to redo}
+@item @url{https://apenwarr.ca/log/20101214, The only build system that might someday replace make... is djb redo}
+@end itemize
+
+@command{goredo} is
+@url{https://www.gnu.org/philosophy/pragmatic.html, copylefted}
+@url{https://www.gnu.org/philosophy/free-sw.html, free software}
+licenced under @url{https://www.gnu.org/licenses/gpl-3.0.html, GNU GPLv3}.
+It should work on all @url{https://en.wikipedia.org/wiki/POSIX,
+POSIX}-compatible systems.
+
+Please send questions, bug reports and patches to
+@url{https://lists.cypherpunks.ru/mailman/listinfo/goredo-devel, goredo-devel}
+maillist. Announcements also go to this mailing list.
+
+@insertcopying
+
+@include features.texi
+@include notes.texi
+@include cmds.texi
+@include news.texi
+@include install.texi
+@include faq.texi
+@include state.texi
+@include thanks.texi
+
+@bye