mirror of
https://github.com/ZoiteChat/zoitechat.git
synced 2026-09-01 04:49:23 +00:00
combine docs into zoitechat repo
This commit is contained in:
69
docs/getting_started.rst
Normal file
69
docs/getting_started.rst
Normal file
@@ -0,0 +1,69 @@
|
||||
Getting Started
|
||||
===============
|
||||
|
||||
Quick Start
|
||||
-----------
|
||||
|
||||
The first time you start ZoiteChat you'll see the *Network List* as seen
|
||||
below:
|
||||
|
||||
.. image:: _static/img/network_list.png
|
||||
|
||||
Here you can specify your global logon details. The *Nick name* will be
|
||||
your name visible in IRC channels (or second/third choice if it's
|
||||
already taken), and the *User name* is how you identify yourself to the
|
||||
server.
|
||||
You can pick a server from the default list, or if it's not there, you
|
||||
can add your own by clicking the *Add* button:
|
||||
|
||||
.. image:: _static/img/network_list_add.png
|
||||
|
||||
After you named it, click *Edit...* and specify the details of your
|
||||
connection. You need at least the following information to join to a
|
||||
certain group of people:
|
||||
|
||||
- server address
|
||||
- server port
|
||||
- channel name
|
||||
|
||||
You can see an example below:
|
||||
|
||||
.. image:: _static/img/network_list_edit.png
|
||||
|
||||
In this example, the server address is *irc.foo.bar* and the port
|
||||
is *6667*. The channel of choice is *#lobby*. Favorite channels are
|
||||
joined to automatically upon connecting to the network. After you
|
||||
finished editing, click *Close* to return to the *Network List*.
|
||||
Now select the network you want to connect to and click *Connect*. After
|
||||
a successful connection you'll see the following window:
|
||||
|
||||
.. image:: _static/img/connection_complete_msg.png
|
||||
|
||||
If you don't want to join a channel just yet, leave it as it is. If you
|
||||
know the channel name already, specify it with the second option. In
|
||||
case you want to browse through the channel list, select the third
|
||||
option. Then press *OK* to close this window.
|
||||
After you successfully joined a channel, you should see something like
|
||||
this:
|
||||
|
||||
.. image:: _static/img/channel_window.png
|
||||
|
||||
That's it, you're online. Now you can learn more about ZoiteChat and
|
||||
customize it for your needs. This website is a good starting point, but
|
||||
you can find a lot more on the net. Have fun!
|
||||
|
||||
Frequently Asked Questions
|
||||
--------------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
faq
|
||||
|
||||
Changelog
|
||||
---------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
changelog
|
||||
Reference in New Issue
Block a user