diff options
-rw-r--r-- | .travis.yml | 5 | ||||
-rwxr-xr-x | CMakeLists.txt | 1 | ||||
-rw-r--r-- | cmake/FindSphinx.cmake | 16 | ||||
-rw-r--r-- | docs/CMakeLists.txt | 40 | ||||
-rw-r--r-- | docs/commands.md | 25 | ||||
-rw-r--r-- | docs/commands.rst | 48 | ||||
-rw-r--r-- | docs/conf.py | 242 | ||||
-rw-r--r-- | docs/index.rst | 25 | ||||
-rw-r--r-- | docs/install.rst | 129 | ||||
-rw-r--r-- | docs/start_guide.de.md | 40 | ||||
-rw-r--r-- | docs/start_guide.de.rst | 66 | ||||
-rw-r--r-- | docs/start_guide.md | 38 | ||||
-rw-r--r-- | docs/start_guide.rst | 63 |
13 files changed, 634 insertions, 104 deletions
diff --git a/.travis.yml b/.travis.yml index 8e71c327..a1a17f61 100644 --- a/.travis.yml +++ b/.travis.yml | |||
@@ -21,12 +21,15 @@ before_script: | |||
21 | - cd .. | 21 | - cd .. |
22 | # creating librarys' links and updating cache | 22 | # creating librarys' links and updating cache |
23 | - sudo ldconfig | 23 | - sudo ldconfig |
24 | 24 | # installing sphinx, needed for documentation | |
25 | - sudo apt-get install python-sphinx | ||
25 | 26 | ||
26 | script: | 27 | script: |
27 | - mkdir build && cd build | 28 | - mkdir build && cd build |
28 | - cmake .. | 29 | - cmake .. |
29 | - make -j3 | 30 | - make -j3 |
31 | # build docs separately | ||
32 | - make docs | ||
30 | 33 | ||
31 | notifications: | 34 | notifications: |
32 | email: false | 35 | email: false |
diff --git a/CMakeLists.txt b/CMakeLists.txt index 9b7db143..bf709e72 100755 --- a/CMakeLists.txt +++ b/CMakeLists.txt | |||
@@ -48,3 +48,4 @@ cmake_policy(SET CMP0011 NEW) | |||
48 | add_subdirectory(core) | 48 | add_subdirectory(core) |
49 | add_subdirectory(testing) | 49 | add_subdirectory(testing) |
50 | add_subdirectory(other) | 50 | add_subdirectory(other) |
51 | add_subdirectory(docs) | ||
diff --git a/cmake/FindSphinx.cmake b/cmake/FindSphinx.cmake new file mode 100644 index 00000000..833bfd4d --- /dev/null +++ b/cmake/FindSphinx.cmake | |||
@@ -0,0 +1,16 @@ | |||
1 | find_program(SPHINX_EXECUTABLE NAMES sphinx-build | ||
2 | HINTS | ||
3 | $ENV{SPHINX_DIR} | ||
4 | PATH_SUFFIXES bin | ||
5 | DOC "Sphinx documentation generator" | ||
6 | ) | ||
7 | |||
8 | include(FindPackageHandleStandardArgs) | ||
9 | |||
10 | find_package_handle_standard_args(Sphinx DEFAULT_MSG | ||
11 | SPHINX_EXECUTABLE | ||
12 | ) | ||
13 | |||
14 | mark_as_advanced( | ||
15 | SPHINX_EXECUTABLE | ||
16 | ) | ||
diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt new file mode 100644 index 00000000..14126cfd --- /dev/null +++ b/docs/CMakeLists.txt | |||
@@ -0,0 +1,40 @@ | |||
1 | # cmake should not fail if sphinx is missing | ||
2 | find_package(Sphinx) | ||
3 | |||
4 | if(SPHINX_EXECUTABLE) | ||
5 | |||
6 | if(NOT DEFINED SPHINX_THEME) | ||
7 | set(SPHINX_THEME default) | ||
8 | endif() | ||
9 | |||
10 | if(NOT DEFINED SPHINX_THEME_DIR) | ||
11 | set(SPHINX_THEME_DIR) | ||
12 | endif() | ||
13 | |||
14 | # configured documentation tools and intermediate build results | ||
15 | set(BINARY_BUILD_DIR "${CMAKE_CURRENT_BINARY_DIR}/_build") | ||
16 | |||
17 | # Sphinx cache with pickled ReST documents | ||
18 | set(SPHINX_CACHE_DIR "${CMAKE_CURRENT_BINARY_DIR}/_doctrees") | ||
19 | |||
20 | # HTML output directory | ||
21 | set(SPHINX_HTML_DIR "${CMAKE_CURRENT_BINARY_DIR}/html") | ||
22 | |||
23 | configure_file( | ||
24 | "${CMAKE_CURRENT_SOURCE_DIR}/conf.py" | ||
25 | "${BINARY_BUILD_DIR}/conf.py" | ||
26 | @ONLY) | ||
27 | |||
28 | add_custom_target(docs | ||
29 | ${SPHINX_EXECUTABLE} | ||
30 | -b html | ||
31 | -c "${BINARY_BUILD_DIR}" | ||
32 | "${CMAKE_CURRENT_SOURCE_DIR}" | ||
33 | "${SPHINX_HTML_DIR}" | ||
34 | COMMENT "Building HTML documentation with Sphinx") | ||
35 | else() | ||
36 | add_custom_target(docs | ||
37 | echo | ||
38 | "Please install python-sphinx to build the docs or read the docs online: https://projecttox.readthedocs.org/en/latest" | ||
39 | COMMENT "No sphinx executebale found") | ||
40 | endif() | ||
diff --git a/docs/commands.md b/docs/commands.md deleted file mode 100644 index 8669bb9b..00000000 --- a/docs/commands.md +++ /dev/null | |||
@@ -1,25 +0,0 @@ | |||
1 | # Tox User Commands | ||
2 | Here's a list of commands that nTox accepts, | ||
3 | which can all be used by starting your line with | ||
4 | a */*. Currently there can be no spaces before this. | ||
5 | |||
6 | * */f* [ID] | ||
7 | + Add a friend with ID [ID]. | ||
8 | * */d* | ||
9 | + Call doMessenger() which does...something? | ||
10 | * */m* \[FRIEND\_NUM\] \[MESSAGE\] | ||
11 | + Message \[FRIEND\_NUM\] \[MESSAGE\]. | ||
12 | * */n* \[NAME\] | ||
13 | + Change your username to \[NAME\]. | ||
14 | * */l* | ||
15 | + Print your list of friends. (like you have any) | ||
16 | * */s* \[STATUS\] | ||
17 | + Set your status to \[STATUS\]. | ||
18 | * */a* \[ID\] | ||
19 | + Accept friend request from \[ID\]. | ||
20 | * */i* | ||
21 | + Print useful info about your client. | ||
22 | * */h* | ||
23 | + Print some help. | ||
24 | * */q/* | ||
25 | + Quit Tox. (why ;_;) | ||
diff --git a/docs/commands.rst b/docs/commands.rst new file mode 100644 index 00000000..ab7e60d1 --- /dev/null +++ b/docs/commands.rst | |||
@@ -0,0 +1,48 @@ | |||
1 | Tox User Commands | ||
2 | ================= | ||
3 | |||
4 | Here's a list of commands that nTox accepts, which can all be used by | ||
5 | starting your line with a */*. Currently there can be no spaces before | ||
6 | this. | ||
7 | |||
8 | - */f* [ID] | ||
9 | |||
10 | - Add a friend with ID [ID]. | ||
11 | |||
12 | - */d* | ||
13 | |||
14 | - Call doMessenger() which does...something? | ||
15 | |||
16 | - */m* [FRIEND\_NUM] [MESSAGE] | ||
17 | |||
18 | - Message [FRIEND\_NUM] [MESSAGE]. | ||
19 | |||
20 | - */n* [NAME] | ||
21 | |||
22 | - Change your username to [NAME]. | ||
23 | |||
24 | - */l* | ||
25 | |||
26 | - Print your list of friends. (like you have any) | ||
27 | |||
28 | - */s* [STATUS] | ||
29 | |||
30 | - Set your status to [STATUS]. | ||
31 | |||
32 | - */a* [ID] | ||
33 | |||
34 | - Accept friend request from [ID]. | ||
35 | |||
36 | - */i* | ||
37 | |||
38 | - Print useful info about your client. | ||
39 | |||
40 | - */h* | ||
41 | |||
42 | - Print some help. | ||
43 | |||
44 | - */q/* | ||
45 | |||
46 | - Quit Tox. (why ;\_;) | ||
47 | |||
48 | |||
diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..afebb632 --- /dev/null +++ b/docs/conf.py | |||
@@ -0,0 +1,242 @@ | |||
1 | # -*- coding: utf-8 -*- | ||
2 | # | ||
3 | # ProjectTox documentation build configuration file, created by | ||
4 | # sphinx-quickstart on Wed Jul 31 23:07:35 2013. | ||
5 | # | ||
6 | # This file is execfile()d with the current directory set to its containing dir. | ||
7 | # | ||
8 | # Note that not all possible configuration values are present in this | ||
9 | # autogenerated file. | ||
10 | # | ||
11 | # All configuration values have a default; values that are commented out | ||
12 | # serve to show the default. | ||
13 | |||
14 | import sys, os | ||
15 | |||
16 | # If extensions (or modules to document with autodoc) are in another directory, | ||
17 | # add these directories to sys.path here. If the directory is relative to the | ||
18 | # documentation root, use os.path.abspath to make it absolute, like shown here. | ||
19 | #sys.path.insert(0, os.path.abspath('.')) | ||
20 | |||
21 | # -- General configuration ----------------------------------------------------- | ||
22 | |||
23 | # If your documentation needs a minimal Sphinx version, state it here. | ||
24 | #needs_sphinx = '1.0' | ||
25 | |||
26 | # Add any Sphinx extension module names here, as strings. They can be extensions | ||
27 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | ||
28 | extensions = [] | ||
29 | |||
30 | # Add any paths that contain templates here, relative to this directory. | ||
31 | templates_path = ['_templates'] | ||
32 | |||
33 | # The suffix of source filenames. | ||
34 | source_suffix = '.rst' | ||
35 | |||
36 | # The encoding of source files. | ||
37 | #source_encoding = 'utf-8-sig' | ||
38 | |||
39 | # The master toctree document. | ||
40 | master_doc = 'index' | ||
41 | |||
42 | # General information about the project. | ||
43 | project = u'ProjectTox' | ||
44 | copyright = u'2013, Tox Team' | ||
45 | |||
46 | # The version info for the project you're documenting, acts as replacement for | ||
47 | # |version| and |release|, also used in various other places throughout the | ||
48 | # built documents. | ||
49 | # | ||
50 | # The short X.Y version. | ||
51 | version = '0.1' | ||
52 | # The full version, including alpha/beta/rc tags. | ||
53 | release = '0.1' | ||
54 | |||
55 | # The language for content autogenerated by Sphinx. Refer to documentation | ||
56 | # for a list of supported languages. | ||
57 | #language = None | ||
58 | |||
59 | # There are two options for replacing |today|: either, you set today to some | ||
60 | # non-false value, then it is used: | ||
61 | #today = '' | ||
62 | # Else, today_fmt is used as the format for a strftime call. | ||
63 | #today_fmt = '%B %d, %Y' | ||
64 | |||
65 | # List of patterns, relative to source directory, that match files and | ||
66 | # directories to ignore when looking for source files. | ||
67 | exclude_patterns = ['_build'] | ||
68 | |||
69 | # The reST default role (used for this markup: `text`) to use for all documents. | ||
70 | #default_role = None | ||
71 | |||
72 | # If true, '()' will be appended to :func: etc. cross-reference text. | ||
73 | #add_function_parentheses = True | ||
74 | |||
75 | # If true, the current module name will be prepended to all description | ||
76 | # unit titles (such as .. function::). | ||
77 | #add_module_names = True | ||
78 | |||
79 | # If true, sectionauthor and moduleauthor directives will be shown in the | ||
80 | # output. They are ignored by default. | ||
81 | #show_authors = False | ||
82 | |||
83 | # The name of the Pygments (syntax highlighting) style to use. | ||
84 | pygments_style = 'sphinx' | ||
85 | |||
86 | # A list of ignored prefixes for module index sorting. | ||
87 | #modindex_common_prefix = [] | ||
88 | |||
89 | |||
90 | # -- Options for HTML output --------------------------------------------------- | ||
91 | |||
92 | # The theme to use for HTML and HTML Help pages. See the documentation for | ||
93 | # a list of builtin themes. | ||
94 | html_theme = 'default' | ||
95 | |||
96 | # Theme options are theme-specific and customize the look and feel of a theme | ||
97 | # further. For a list of options available for each theme, see the | ||
98 | # documentation. | ||
99 | #html_theme_options = {} | ||
100 | |||
101 | # Add any paths that contain custom themes here, relative to this directory. | ||
102 | #html_theme_path = [] | ||
103 | |||
104 | # The name for this set of Sphinx documents. If None, it defaults to | ||
105 | # "<project> v<release> documentation". | ||
106 | #html_title = None | ||
107 | |||
108 | # A shorter title for the navigation bar. Default is the same as html_title. | ||
109 | #html_short_title = None | ||
110 | |||
111 | # The name of an image file (relative to this directory) to place at the top | ||
112 | # of the sidebar. | ||
113 | #html_logo = None | ||
114 | |||
115 | # The name of an image file (within the static path) to use as favicon of the | ||
116 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 | ||
117 | # pixels large. | ||
118 | #html_favicon = None | ||
119 | |||
120 | # Add any paths that contain custom static files (such as style sheets) here, | ||
121 | # relative to this directory. They are copied after the builtin static files, | ||
122 | # so a file named "default.css" will overwrite the builtin "default.css". | ||
123 | html_static_path = ['_static'] | ||
124 | |||
125 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | ||
126 | # using the given strftime format. | ||
127 | #html_last_updated_fmt = '%b %d, %Y' | ||
128 | |||
129 | # If true, SmartyPants will be used to convert quotes and dashes to | ||
130 | # typographically correct entities. | ||
131 | #html_use_smartypants = True | ||
132 | |||
133 | # Custom sidebar templates, maps document names to template names. | ||
134 | #html_sidebars = {} | ||
135 | |||
136 | # Additional templates that should be rendered to pages, maps page names to | ||
137 | # template names. | ||
138 | #html_additional_pages = {} | ||
139 | |||
140 | # If false, no module index is generated. | ||
141 | #html_domain_indices = True | ||
142 | |||
143 | # If false, no index is generated. | ||
144 | #html_use_index = True | ||
145 | |||
146 | # If true, the index is split into individual pages for each letter. | ||
147 | #html_split_index = False | ||
148 | |||
149 | # If true, links to the reST sources are added to the pages. | ||
150 | #html_show_sourcelink = True | ||
151 | |||
152 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. | ||
153 | #html_show_sphinx = True | ||
154 | |||
155 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. | ||
156 | #html_show_copyright = True | ||
157 | |||
158 | # If true, an OpenSearch description file will be output, and all pages will | ||
159 | # contain a <link> tag referring to it. The value of this option must be the | ||
160 | # base URL from which the finished HTML is served. | ||
161 | #html_use_opensearch = '' | ||
162 | |||
163 | # This is the file name suffix for HTML files (e.g. ".xhtml"). | ||
164 | #html_file_suffix = None | ||
165 | |||
166 | # Output file base name for HTML help builder. | ||
167 | htmlhelp_basename = 'ProjectToxdoc' | ||
168 | |||
169 | |||
170 | # -- Options for LaTeX output -------------------------------------------------- | ||
171 | |||
172 | latex_elements = { | ||
173 | # The paper size ('letterpaper' or 'a4paper'). | ||
174 | #'papersize': 'letterpaper', | ||
175 | |||
176 | # The font size ('10pt', '11pt' or '12pt'). | ||
177 | #'pointsize': '10pt', | ||
178 | |||
179 | # Additional stuff for the LaTeX preamble. | ||
180 | #'preamble': '', | ||
181 | } | ||
182 | |||
183 | # Grouping the document tree into LaTeX files. List of tuples | ||
184 | # (source start file, target name, title, author, documentclass [howto/manual]). | ||
185 | latex_documents = [ | ||
186 | ('index', 'ProjectTox.tex', u'ProjectTox Documentation', | ||
187 | u'Tox Team', 'manual'), | ||
188 | ] | ||
189 | |||
190 | # The name of an image file (relative to this directory) to place at the top of | ||
191 | # the title page. | ||
192 | #latex_logo = None | ||
193 | |||
194 | # For "manual" documents, if this is true, then toplevel headings are parts, | ||
195 | # not chapters. | ||
196 | #latex_use_parts = False | ||
197 | |||
198 | # If true, show page references after internal links. | ||
199 | #latex_show_pagerefs = False | ||
200 | |||
201 | # If true, show URL addresses after external links. | ||
202 | #latex_show_urls = False | ||
203 | |||
204 | # Documents to append as an appendix to all manuals. | ||
205 | #latex_appendices = [] | ||
206 | |||
207 | # If false, no module index is generated. | ||
208 | #latex_domain_indices = True | ||
209 | |||
210 | |||
211 | # -- Options for manual page output -------------------------------------------- | ||
212 | |||
213 | # One entry per manual page. List of tuples | ||
214 | # (source start file, name, description, authors, manual section). | ||
215 | man_pages = [ | ||
216 | ('index', 'projecttox', u'ProjectTox Documentation', | ||
217 | [u'Tox Team'], 1) | ||
218 | ] | ||
219 | |||
220 | # If true, show URL addresses after external links. | ||
221 | #man_show_urls = False | ||
222 | |||
223 | |||
224 | # -- Options for Texinfo output ------------------------------------------------ | ||
225 | |||
226 | # Grouping the document tree into Texinfo files. List of tuples | ||
227 | # (source start file, target name, title, author, | ||
228 | # dir menu entry, description, category) | ||
229 | texinfo_documents = [ | ||
230 | ('index', 'ProjectTox', u'ProjectTox Documentation', | ||
231 | u'Tox Team', 'ProjectTox', 'One line description of project.', | ||
232 | 'Miscellaneous'), | ||
233 | ] | ||
234 | |||
235 | # Documents to append as an appendix to all manuals. | ||
236 | #texinfo_appendices = [] | ||
237 | |||
238 | # If false, no module index is generated. | ||
239 | #texinfo_domain_indices = True | ||
240 | |||
241 | # How to display URL addresses: 'footnote', 'no', or 'inline'. | ||
242 | #texinfo_show_urls = 'footnote' | ||
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..10e0d1d2 --- /dev/null +++ b/docs/index.rst | |||
@@ -0,0 +1,25 @@ | |||
1 | .. ProjectTox documentation master file, created by | ||
2 | sphinx-quickstart on Wed Jul 31 23:07:35 2013. | ||
3 | You can adapt this file completely to your liking, but it should at least | ||
4 | contain the root `toctree` directive. | ||
5 | |||
6 | Welcome to ProjectTox's documentation! | ||
7 | ====================================== | ||
8 | |||
9 | Contents: | ||
10 | |||
11 | .. toctree:: | ||
12 | start_guide.rst | ||
13 | install.rst | ||
14 | commands.rst | ||
15 | :maxdepth: 2 | ||
16 | |||
17 | |||
18 | |||
19 | Indices and tables | ||
20 | ================== | ||
21 | |||
22 | * :ref:`genindex` | ||
23 | * :ref:`modindex` | ||
24 | * :ref:`search` | ||
25 | |||
diff --git a/docs/install.rst b/docs/install.rst new file mode 100644 index 00000000..c5fea5d1 --- /dev/null +++ b/docs/install.rst | |||
@@ -0,0 +1,129 @@ | |||
1 | Install Instructions | ||
2 | ==================== | ||
3 | |||
4 | Linux | ||
5 | --------- | ||
6 | |||
7 | First, install the build dependencies :: | ||
8 | |||
9 | bash apt-get install build-essential libtool autotools-dev automake libconfig-dev ncurses-dev cmake checkinstall | ||
10 | |||
11 | .. note :: ``libconfig-dev`` should be >= 1.4. | ||
12 | |||
13 | |||
14 | Then you'll need a recent version of `libsodium <https://github.com/jedisct1/libsodium>`_ :: | ||
15 | |||
16 | git clone git://github.com/jedisct1/libsodium.git | ||
17 | cd libsodium | ||
18 | git checkout tags/0.4.2 | ||
19 | ./autogen.sh | ||
20 | ./configure && make check | ||
21 | sudo checkinstall --install --pkgname libsodium --pkgversion 0.4.2 --nodoc | ||
22 | sudo ldconfig`` | ||
23 | |||
24 | Finally, fetch the Tox source code and run cmake :: | ||
25 | |||
26 | git clone git://github.com/irungentoo/ProjectTox-Core.git | ||
27 | cd ProjectTox-Core && mkdir build && cd build | ||
28 | cmake .. | ||
29 | |||
30 | Then you can build any of the files in `/testing`_ and `/other`_ that are currently | ||
31 | supported on your platform by running :: | ||
32 | |||
33 | make name_of_c_file | ||
34 | |||
35 | For example, to build `Messenger_test.c`_ you would run :: | ||
36 | |||
37 | make Messenger_test | ||
38 | |||
39 | |||
40 | Or you could just build everything that is supported on your platform by | ||
41 | running :: | ||
42 | bash make | ||
43 | |||
44 | OS X | ||
45 | ------ | ||
46 | |||
47 | Homebrew | ||
48 | ~~~~~~~~~~ | ||
49 | :: | ||
50 | |||
51 | brew install libtool automake autoconf libconfig libsodium cmake | ||
52 | cmake . | ||
53 | make | ||
54 | sudo make install | ||
55 | |||
56 | Non-homebrew | ||
57 | ~~~~~~~~~~~~ | ||
58 | |||
59 | Much the same as Linux, remember to install the latest XCode and the | ||
60 | developer tools (Preferences -> Downloads -> Command Line Tools). Users | ||
61 | running Mountain Lion and the latest version of XCode (4.6.3) will also | ||
62 | need to install libtool, automake and autoconf. They are easy enough to | ||
63 | install, grab them from http://www.gnu.org/software/libtool/, | ||
64 | http://www.gnu.org/software/autoconf/ and | ||
65 | http://www.gnu.org/software/automake/, then follow these steps for each: | ||
66 | |||
67 | :: | ||
68 | |||
69 | ./configure | ||
70 | make | ||
71 | sudo make install | ||
72 | |||
73 | Do not install them from macports (or any dependencies for that matter) | ||
74 | as they get shoved in the wrong directory and make your life more | ||
75 | annoying. | ||
76 | |||
77 | Another thing you may want to install is the latest gcc, this caused me | ||
78 | a few problems as XCode from 4.3 no longer includes gcc and instead uses | ||
79 | LLVM-GCC, a nice install guide can be found at | ||
80 | http://caiustheory.com/install-gcc-421-apple-build-56663-with-xcode-42 | ||
81 | |||
82 | Windows | ||
83 | --------- | ||
84 | |||
85 | You should install: | ||
86 | |||
87 | * `MinGW <http://sourceforge.net/projects/mingw/>`_'s C compiler | ||
88 | * `CMake <http://www.cmake.org/cmake/resources/software.html>`_ | ||
89 | |||
90 | You have to `modify your PATH environment | ||
91 | variable <http://www.computerhope.com/issues/ch000549.htm>`_ so that it | ||
92 | contains MinGW's bin folder path. With default settings, the bin folder | ||
93 | is located at ``C:\MinGW\bin``, which means that you would have to | ||
94 | append ``;C:\MinGW\bin`` to the PATH variable. | ||
95 | |||
96 | Then you should either clone this repo by using git, or just download a | ||
97 | `zip of current Master | ||
98 | branch <https://github.com/irungentoo/ProjectTox-Core/archive/master.zip>`_ | ||
99 | and extract it somewhere. | ||
100 | |||
101 | After that you should get precompiled package of libsodium from | ||
102 | `here <https://download.libsodium.org/libsodium/releases/libsodium-win32-0.4.2.tar.gz>`_ | ||
103 | and extract the archive into this repo's root. That is, ``sodium`` | ||
104 | folder should be along with ``core``, ``testing`` and other folders. | ||
105 | |||
106 | Navigate in ``cmd`` to this repo and run:: | ||
107 | |||
108 | mkdir build && cd build | ||
109 | cmake -G "MinGW Makefiles" .. | ||
110 | |||
111 | Then you can build any of the `/testing`_ and `/other`_ that are currently | ||
112 | supported on your platform by running:: | ||
113 | |||
114 | mingw32-make name_of_c_file | ||
115 | |||
116 | For example, to build `Messenger_test.c`_ you would run:: | ||
117 | |||
118 | mingw32-make Messenger_test`` | ||
119 | |||
120 | Or you could just build everything that is supported on your platform by | ||
121 | running:: | ||
122 | |||
123 | mingw32-make | ||
124 | |||
125 | |||
126 | .. _/testing: https://github.com/irungentoo/ProjectTox-Core/tree/master/testing | ||
127 | .. _/other: https://github.com/irungentoo/ProjectTox-Core/tree/master/other | ||
128 | |||
129 | .. _Messenger_test.c: https://github.com/irungentoo/ProjectTox-Core/tree/master/other/Messanger_test.c | ||
diff --git a/docs/start_guide.de.md b/docs/start_guide.de.md deleted file mode 100644 index 7dfd52ca..00000000 --- a/docs/start_guide.de.md +++ /dev/null | |||
@@ -1,40 +0,0 @@ | |||
1 | # Tox nutzen | ||
2 | 1. Tox erstellen | ||
3 | 2. Fehler korrigieren | ||
4 | 3. Im IRC nach Hilfe fragen | ||
5 | 4. Auf Debug-Reise für Entwickler | ||
6 | 5. Tox wirklich erstellen | ||
7 | 6. ??? | ||
8 | |||
9 | Trotz der ganzen Arbeit, die wir bisher in Tox | ||
10 | gesteckt haben, gibt es noch keine richtige | ||
11 | Anleitung, wie man Tox _benutzt_. | ||
12 | Dies ist ein anwenderfreundlicher Versuch. | ||
13 | |||
14 | 1. Verbinde dich zum Netzwerk! | ||
15 | + Du musst dich zu einem Bootstrap-Server verbinden, um einen öffentlichen Schlüssel zu erhalten. | ||
16 | + Wo finde ich einen öffentlichen Server? Zur Zeit hier: | ||
17 | (die Hilfe-Nachricht von nTox ohne Kommandos hilft auch) | ||
18 | + 198.46.136.167 33445 728925473812C7AAC482BE7250BCCAD0B8CB9F737BF3D42ABD34459C1768F854 | ||
19 | + 192.81.133.111 33445 8CD5A9BF0A6CE358BA36F7A653F99FA6B258FF756E490F52C1F98CC420F78858 | ||
20 | + 66.175.223.88 33445 AC4112C975240CAD260BB2FCD134266521FAAF0A5D159C5FD3201196191E4F5D | ||
21 | + 192.184.81.118 33445 5CD7EB176C19A2FD840406CD56177BB8E75587BB366F7BB3004B19E3EDC04143 | ||
22 | 2. Finde einen Freund! | ||
23 | + Jetzt, da du im Netzwerk bist, brauchst du einen Freund. Um einen zu bekommen, | ||
24 | musst du eine Anfrage senden oder erhalten. Was eine Anfrage ist? | ||
25 | Es ist wie eine Freundschaftsanfrage, jedoch benutzen wir unglaublich schaurige | ||
26 | und kryptische Nummern anstatt Namen. When nTox startet, erscheint _deine_ lange, | ||
27 | schaurige Nummer, auch *öffentlicher Schlüssel* genannt. Diesen kannst du an | ||
28 | andere Personen weitergeben und sie können dich als "Freund" hinzufügen. Oder du | ||
29 | fügst andere Personen mit dem */f*-Befehl hinzu, wenn du möchtest. | ||
30 | 3. Chatte drauf los! | ||
31 | + Benutze nun den */m*-Befehl, um eine Nachricht an jemanden zu senden. Wow, du chattest! | ||
32 | 4. Mach etwas kaputt! | ||
33 | + Jep, pre-alpha-alpha-Software stürzt manchmal ab. Wir arbeiten daran. | ||
34 | + Bitte melde alle Abstürze entweder an die GitHub-Seite oder #tox-dev im freenode-IRC. | ||
35 | 5. Nichts ist kaputt, aber was bedeutet */f*? | ||
36 | + nTox liest einen Text als Befehl, wenn das erste Zeichen ein Schrägstrich ist ('/'). | ||
37 | Du kannst alle Befehle in commands.md nachlesen. | ||
38 | 6. Benutze und unterstütze Tox! | ||
39 | + Programmiere, debugge, dokumentiere, übersetze für uns, oder sprich einfach über uns! | ||
40 | + Je mehr Interesse wir erhalten, desto mehr Arbeit wird getan und desto besser wird Tox. | ||
diff --git a/docs/start_guide.de.rst b/docs/start_guide.de.rst new file mode 100644 index 00000000..4ebe7dc6 --- /dev/null +++ b/docs/start_guide.de.rst | |||
@@ -0,0 +1,66 @@ | |||
1 | Tox nutzen | ||
2 | ========== | ||
3 | |||
4 | 1. :doc:`Tox erstellen <install>` | ||
5 | 2. Fehler korrigieren | ||
6 | 3. Im IRC nach Hilfe fragen | ||
7 | 4. Auf Debug-Reise für Entwickler | ||
8 | 5. Tox wirklich erstellen | ||
9 | 6. ??? | ||
10 | |||
11 | Trotz der ganzen Arbeit, die wir bisher in Tox gesteckt haben, gibt es | ||
12 | noch keine richtige Anleitung, wie man Tox *benutzt*. Dies ist ein | ||
13 | anwenderfreundlicher Versuch. | ||
14 | |||
15 | 1. Verbinde dich zum Netzwerk! | ||
16 | |||
17 | - Du musst dich zu einem Bootstrap-Server verbinden, um einen | ||
18 | öffentlichen Schlüssel zu erhalten. | ||
19 | - Wo finde ich einen öffentlichen Server? Zur Zeit hier: (die | ||
20 | Hilfe-Nachricht von nTox ohne Kommandos hilft auch) | ||
21 | |||
22 | - 198.46.136.167 33445 | ||
23 | 728925473812C7AAC482BE7250BCCAD0B8CB9F737BF3D42ABD34459C1768F854 | ||
24 | - 192.81.133.111 33445 | ||
25 | 8CD5A9BF0A6CE358BA36F7A653F99FA6B258FF756E490F52C1F98CC420F78858 | ||
26 | - 66.175.223.88 33445 | ||
27 | AC4112C975240CAD260BB2FCD134266521FAAF0A5D159C5FD3201196191E4F5D | ||
28 | - 192.184.81.118 33445 | ||
29 | 5CD7EB176C19A2FD840406CD56177BB8E75587BB366F7BB3004B19E3EDC04143 | ||
30 | |||
31 | 2. Finde einen Freund! | ||
32 | |||
33 | - Jetzt, da du im Netzwerk bist, brauchst du einen Freund. Um einen | ||
34 | zu bekommen, musst du eine Anfrage senden oder erhalten. Was eine | ||
35 | Anfrage ist? Es ist wie eine Freundschaftsanfrage, jedoch benutzen | ||
36 | wir unglaublich schaurige und kryptische Nummern anstatt Namen. | ||
37 | When nTox startet, erscheint *deine* lange, schaurige Nummer, auch | ||
38 | *öffentlicher Schlüssel* genannt. Diesen kannst du an andere | ||
39 | Personen weitergeben und sie können dich als "Freund" hinzufügen. | ||
40 | Oder du fügst andere Personen mit dem */f*-Befehl hinzu, wenn du | ||
41 | möchtest. | ||
42 | |||
43 | 3. Chatte drauf los! | ||
44 | |||
45 | - Benutze nun den */m*-Befehl, um eine Nachricht an jemanden zu | ||
46 | senden. Wow, du chattest! | ||
47 | |||
48 | 4. Mach etwas kaputt! | ||
49 | |||
50 | - Jep, pre-alpha-alpha-Software stürzt manchmal ab. Wir arbeiten | ||
51 | daran. | ||
52 | - Bitte melde alle Abstürze entweder an die GitHub-Seite oder | ||
53 | #tox-dev im freenode-IRC. | ||
54 | |||
55 | 5. Nichts ist kaputt, aber was bedeutet */f*? | ||
56 | |||
57 | - nTox liest einen Text als Befehl, wenn das erste Zeichen ein | ||
58 | Schrägstrich ist ('/'). Du kannst alle Befehle in commands.md | ||
59 | nachlesen. | ||
60 | |||
61 | 6. Benutze und unterstütze Tox! | ||
62 | |||
63 | - Programmiere, debugge, dokumentiere, übersetze für uns, oder | ||
64 | sprich einfach über uns! | ||
65 | - Je mehr Interesse wir erhalten, desto mehr Arbeit wird getan und | ||
66 | desto besser wird Tox. | ||
diff --git a/docs/start_guide.md b/docs/start_guide.md deleted file mode 100644 index 9ced4078..00000000 --- a/docs/start_guide.md +++ /dev/null | |||
@@ -1,38 +0,0 @@ | |||
1 | # Using Tox | ||
2 | 1. [Build Tox](../INSTALL.md) | ||
3 | 2. Fix errors | ||
4 | 3. Consult IRC for help | ||
5 | 4. Go on debugging journey for devs | ||
6 | 5. Build Tox for real | ||
7 | 6. ??? | ||
8 | |||
9 | For all the work we've put into Tox so far, | ||
10 | there isn't yet a decent guide for how you _use_ | ||
11 | Tox. Here's a user-friendly attempt at it. | ||
12 | |||
13 | 1. Connect to the network! | ||
14 | + You need to connect to a bootstrapping server, to give you a public key. | ||
15 | + Where can I find a public server? Right here, as of now: | ||
16 | (the help message from running `nTox` with no args will help) | ||
17 | + `198.46.136.167 33445 728925473812C7AAC482BE7250BCCAD0B8CB9F737BF3D42ABD34459C1768F854` | ||
18 | + `192.81.133.111 33445 8CD5A9BF0A6CE358BA36F7A653F99FA6B258FF756E490F52C1F98CC420F78858` | ||
19 | + `66.175.223.88 33445 AC4112C975240CAD260BB2FCD134266521FAAF0A5D159C5FD3201196191E4F5D` | ||
20 | + `192.184.81.118 33445 5CD7EB176C19A2FD840406CD56177BB8E75587BB366F7BB3004B19E3EDC04143` | ||
21 | 2. Find a friend! | ||
22 | + Now that you're on the network, you need a friend. To get one of those, | ||
23 | you need to to send or receive a request. What's a request, you ask? | ||
24 | It's like a friend request, but we use really scary and cryptic numbers | ||
25 | instead of names. When `nTox` starts, it shows _your_ long, scary number, | ||
26 | called your *public key*. Give that to people, and they can add you as | ||
27 | a "friend". Or, you can add someone else, with the `/f` command, if you like. | ||
28 | 3. Chat it up! | ||
29 | + Now use the `/m` command to send a message to someone. Wow, you're chatting! | ||
30 | 4. But something broke! | ||
31 | + Yeah, pre-alpha-alpha software tends to do that. We're working on it. | ||
32 | + Please report all crashes to either the GitHub page, or `#tox-dev` on freenode. | ||
33 | 5. Nothing broke, but what does `/f` mean? | ||
34 | + `nTox` parses text as a command if the first character is a forward-slash (`/`). | ||
35 | You can check all commands in commands.md. | ||
36 | 6. Use and support Tox! | ||
37 | + Code for us, debug for us, document for us, translate for us, even just talk about us! | ||
38 | + The more interest we get, the more work gets done, the better Tox is. | ||
diff --git a/docs/start_guide.rst b/docs/start_guide.rst new file mode 100644 index 00000000..19ef982e --- /dev/null +++ b/docs/start_guide.rst | |||
@@ -0,0 +1,63 @@ | |||
1 | Using Tox | ||
2 | ========= | ||
3 | |||
4 | .. note:: There is a German version of this page available: :doc:`start_guide.de` | ||
5 | |||
6 | |||
7 | 1. :doc:`Build Tox <install>` | ||
8 | 2. Fix errors | ||
9 | 3. Consult IRC for help | ||
10 | 4. Go on debugging journey for devs | ||
11 | 5. Build Tox for real | ||
12 | 6. ??? | ||
13 | |||
14 | For all the work we've put into Tox so far, there isn't yet a decent | ||
15 | guide for how you *use* Tox. Here's a user-friendly attempt at it. | ||
16 | |||
17 | 1. Connect to the network! | ||
18 | |||
19 | - You need to connect to a bootstrapping server, to give you a | ||
20 | public key. | ||
21 | - Where can I find a public server? Right here, as of now: (the help | ||
22 | message from running ``nTox`` with no args will help) | ||
23 | |||
24 | - ``198.46.136.167 33445 728925473812C7AAC482BE7250BCCAD0B8CB9F737BF3D42ABD34459C1768F854`` | ||
25 | - ``192.81.133.111 33445 8CD5A9BF0A6CE358BA36F7A653F99FA6B258FF756E490F52C1F98CC420F78858`` | ||
26 | - ``66.175.223.88 33445 AC4112C975240CAD260BB2FCD134266521FAAF0A5D159C5FD3201196191E4F5D`` | ||
27 | - ``192.184.81.118 33445 5CD7EB176C19A2FD840406CD56177BB8E75587BB366F7BB3004B19E3EDC04143`` | ||
28 | |||
29 | 2. Find a friend! | ||
30 | |||
31 | - Now that you're on the network, you need a friend. To get one of | ||
32 | those, you need to to send or receive a request. What's a request, | ||
33 | you ask? It's like a friend request, but we use really scary and | ||
34 | cryptic numbers instead of names. When ``nTox`` starts, it shows | ||
35 | *your* long, scary number, called your *public key*. Give that to | ||
36 | people, and they can add you as a "friend". Or, you can add | ||
37 | someone else, with the ``/f`` command, if you like. | ||
38 | |||
39 | 3. Chat it up! | ||
40 | |||
41 | - Now use the ``/m`` command to send a message to someone. Wow, | ||
42 | you're chatting! | ||
43 | |||
44 | 4. But something broke! | ||
45 | |||
46 | - Yeah, pre-alpha-alpha software tends to do that. We're working on | ||
47 | it. | ||
48 | - Please report all crashes to either the GitHub page, or | ||
49 | ``#tox-dev`` on freenode. | ||
50 | |||
51 | 5. Nothing broke, but what does ``/f`` mean? | ||
52 | |||
53 | - ``nTox`` parses text as a command if the first character is a | ||
54 | forward-slash (``/``). You can check all commands in commands.md. | ||
55 | |||
56 | 6. Use and support Tox! | ||
57 | |||
58 | - Code for us, debug for us, document for us, translate for us, even | ||
59 | just talk about us! | ||
60 | - The more interest we get, the more work gets done, the better Tox | ||
61 | is. | ||
62 | |||
63 | |||