gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[GNUnet-SVN] [gnunet-texinfo] branch master updated: add a README.


From: gnunet
Subject: [GNUnet-SVN] [gnunet-texinfo] branch master updated: add a README.
Date: Sat, 13 May 2017 14:52:32 +0200

This is an automated email from the git hooks/post-receive script.

ng0 pushed a commit to branch master
in repository gnunet-texinfo.

The following commit(s) were added to refs/heads/master by this push:
     new be212d1  add a README.
be212d1 is described below

commit be212d117657f5af570ca3ef0281209e6c7b052a
Author: ng0 <address@hidden>
AuthorDate: Fri Feb 17 16:58:26 2017 +0000

    add a README.
---
 .gitignore |  3 ++-
 README     | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 TODO       |  9 ---------
 3 files changed, 59 insertions(+), 10 deletions(-)

diff --git a/.gitignore b/.gitignore
index 0425a95..cc9c5a2 100644
--- a/.gitignore
+++ b/.gitignore
@@ -4,4 +4,5 @@
 *.toc
 *.cp
 *.cps
-*.html
\ No newline at end of file
+*.html
+*~
\ No newline at end of file
diff --git a/README b/README
new file mode 100644
index 0000000..35a3210
--- /dev/null
+++ b/README
@@ -0,0 +1,57 @@
+GNUnet-texinfo
+==============
+
+The purpose of this project is to fix the documentation
+export from Drupal to texinfo into valid texinfo, so that
+if produces correct html, pdf, etc outputs.
+
+You can cat the Makefile to see which targets 'make' offers
+and which binaries you require for them (currently there is
+makeinfo, texi2pdf, texi2html involved).
+
+For reference with the original, you want to browse the
+documentation at https://gnunet.org and select the appropriate
+book.
+
+Commits directly to gnunet.org must be signed.
+
+The following are just email dumps:
+-----------------------------------
+
+> I think my initial idea to separate documentation for users and
+> developers is not good.
+
+Ok. Well, I think it ultimately depends on how easy it is to navigate,
+and how you define "users".  As we right now have mostly middleware,
+users = devs anyway. We just need to make sure tha the (relatively)
+end-user stuff like installation instructions, or the tiny parts on how
+to *use* file-sharing or conversation can be located by people who don't
+care deeply about the technology.
+
+> Furthermore it would make the project's documentation seem more
+> approachable, no separation of use clases.
+> The separation will still exist, but if I present first the Introduction
+> (Philosophy), then the User Documentation, and afterwards the big
+> mountain of Developer Documentation, it's still accessible to those who
+> don't want to be bothered by Developer texts.
+
+TODO
+----
+
+CHAPTERS
+* [] All files: move @settitle's to @node's
+* [] All files: move @node's then to @node with specific sub-@'s
+
+UNION
+* [x] Move all files -> gnunet.texi
+  Achieved by having gnunet.texi include all the other files.
+
+TARGETS
+* [] HTML renders correctly
+* [] PDF renders correctly
+* [] info renders correctly
+
+MISC
+* [] All images are visible
+* [] All images have alt-text in html
+* [] All images have a description in pdf and makeinfo outputs
\ No newline at end of file
diff --git a/TODO b/TODO
deleted file mode 100644
index 7e20356..0000000
--- a/TODO
+++ /dev/null
@@ -1,9 +0,0 @@
-# CHAPTERS
-[] All files: move @settitle's to @node's
-[] All files: move @node's then to @node with specific sub-@'s
-
-# UNION
-[] Move all files -> gnunet.texi
-
-# FOUND ART
-TRANSPORT SUBSYSTEM -> WLAN is undocumented

-- 
To stop receiving notification emails like this one, please contact
address@hidden



reply via email to

[Prev in Thread] Current Thread [Next in Thread]