Browse Source

Rename project to uirc3

Přemysl Janouch 3 years ago
parent
commit
37fa19f4c9
8 changed files with 50 additions and 37 deletions
  1. 4
    4
      .gitignore
  2. 2
    2
      .travis.yml
  3. 2
    2
      CMakeLists.txt
  4. 40
    25
      README
  5. 0
    2
      config.h.in
  6. 0
    1
      degesch.c
  7. 0
    1
      kike.c
  8. 2
    0
      zyklonb.c

+ 4
- 4
.gitignore View File

@@ -3,7 +3,7 @@
3 3
 
4 4
 # Qt Creator files
5 5
 /CMakeLists.txt.user*
6
-/ZyklonB.config
7
-/ZyklonB.files
8
-/ZyklonB.creator*
9
-/ZyklonB.includes
6
+/uirc3.config
7
+/uirc3.files
8
+/uirc3.creator*
9
+/uirc3.includes

+ 2
- 2
.travis.yml View File

@@ -10,8 +10,8 @@ env:
10 10
 addons:
11 11
  coverity_scan:
12 12
   project:
13
-   name: "pjanouch/ZyklonB"
14
-   description: "Experimental IRC bot & daemon"
13
+   name: "pjanouch/uirc3"
14
+   description: "Experimental IRC client, daemon and bot"
15 15
   notification_email: p.janouch@gmail.com
16 16
   build_command_prepend: "cmake .. -DCMAKE_BUILD_TYPE=Release"
17 17
   build_command: "make"

+ 2
- 2
CMakeLists.txt View File

@@ -1,4 +1,4 @@
1
-project (ZyklonB C)
1
+project (uirc3 C)
2 2
 cmake_minimum_required (VERSION 2.8.5)
3 3
 
4 4
 # Moar warnings
@@ -100,7 +100,7 @@ foreach (page ${project_MAN_PAGES})
100 100
 endforeach (page)
101 101
 
102 102
 # CPack
103
-set (CPACK_PACKAGE_DESCRIPTION_SUMMARY "Experimental IRC bot, client and daemon")
103
+set (CPACK_PACKAGE_DESCRIPTION_SUMMARY "Experimental IRC client, daemon and bot")
104 104
 set (CPACK_PACKAGE_VERSION ${project_VERSION})
105 105
 set (CPACK_PACKAGE_VENDOR "Premysl Janouch")
106 106
 set (CPACK_PACKAGE_CONTACT "Přemysl Janouch <p.janouch@gmail.com>")

+ 40
- 25
README View File

@@ -1,43 +1,58 @@
1
-ZyklonB
2
-=======
1
+uirc3
2
+=====
3
+The unethical IRC trinity.  This project consists of an experimental IRC client,
4
+daemon, and bot.  It's all you're ever going to need for chatting.
3 5
 
4
-`ZyklonB' is an experimental IRC bot, building upon the concept of my other
5
-VitaminA IRC bot.  The main characteristic of these two bots is that they run
6
-plugins as coprocesses, which allows for enhanced reliability and programming
7
-language freedom.
6
+All of them have these potentially interesting properties:
7
+ - full IPv6 support
8
+ - SSL/TLS support, including client certificates
9
+ - minimal dependencies
10
+ - very compact and easy to hack on
8 11
 
9
-While originally intended to be a simple C99 rewrite of the original bot, which
10
-was written in the GNU dialect of AWK, it fairly quickly became a playground
11
-where I added everything that seemed nice.
12
+degesch
13
+-------
14
+The IRC client.  I thought it would be interesting to build an IRC client on
15
+top of libreadline.  At least it's way simpler than doing it in ncurses.
16
+The interface should feel familiar for weechat users.
17
+
18
+It's the youngest and largest of them all and currently under heavy development.
12 19
 
13 20
 kike
14 21
 ----
15
-Also included is a simple IRC daemon that mostly follows the RFC's but is
16
-limited to single-server networks, due to the protocol being incredibly ugly and
17
-tricky to implement correctly (the poor quality of the RFC's doesn't help).  It
18
-is designed for use as a regular user application rather than a system daemon.
22
+The IRC daemon.  It mostly follows RFCs but it can't form networks consisting
23
+of multiple servers, or use any services packages, such as Atheme.  (Mostly due
24
+to the protocol being incredibly ugly and tricky to implement correctly, with
25
+the poor quality of the RFCs not helping much).  It is designed to be used as
26
+a regular user application rather than a system daemon.
19 27
 
20 28
 It is complete enough to be useful but there are still some things that need to
21 29
 be resolved before I can consider it stable.
22 30
 
23
-Some interesting features:
24
- - SSL/TLS autodetection
31
+Notable features:
32
+ - SSL/TLS autodetection (why doesn't everyone have this?)
25 33
  - IRCop authentication through SSL/TLS client certificates
26
- - epoll support on Linux
27
- - superfast build time, small memory footprint
34
+ - epoll support on Linux; it should be able to handle quite a number of users
28 35
 
29
-degesch
36
+ZyklonB
30 37
 -------
31
-To complete it all, I've also started working on an IRC client.  I thought it
32
-would be interesting to build an IRC client on top of libreadline.  Also way
33
-simpler than doing it in ncurses.
38
+The IRC bot.  It builds upon the concept of my other VitaminA IRC bot.  The main
39
+characteristic of these two bots is that they run plugins as coprocesses, which
40
+allows for enhanced reliability and programming language freedom.
41
+
42
+While originally intended to be a simple C99 rewrite of the original bot, which
43
+was written in the GNU dialect of AWK, it fairly quickly became a playground
44
+where I added everything that seemed nice.
45
+
46
+Notable features:
47
+ - resilient against crashes, server disconnects and timeouts
48
+ - SOCKS support (even though socksify can add that easily to any program)
34 49
 
35 50
 Building
36 51
 --------
37 52
 Build dependencies: CMake, pkg-config, help2man, awk, sh, liberty (included)
38
-Runtime dependencies: openssl, ncursesw (degesch), readline (degesch)
53
+Runtime dependencies: openssl, curses (degesch), readline (degesch)
39 54
 
40
- $ git clone https://github.com/pjanouch/ZyklonB.git
55
+ $ git clone https://github.com/pjanouch/uirc3.git
41 56
  $ git submodule init
42 57
  $ git submodule update
43 58
  $ mkdir build
@@ -50,7 +65,7 @@ To install the application, you can do either the usual:
50 65
 
51 66
 Or you can try telling CMake to make a package for you.  For Debian it is:
52 67
  $ cpack -G DEB
53
- # dpkg -i ZyklonB-*.deb
68
+ # dpkg -i uirc3-*.deb
54 69
 
55 70
 Note that for versions of CMake before 2.8.9, you need to prefix cpack with
56 71
 `fakeroot' or file ownership will end up wrong.
@@ -83,7 +98,7 @@ And no, I'm not going to change the names.
83 98
 
84 99
 License
85 100
 -------
86
-`ZyklonB' is written by Přemysl Janouch <p.janouch@gmail.com>.
101
+`uirc3' is written by Přemysl Janouch <p.janouch@gmail.com>.
87 102
 
88 103
 You may use the software under the terms of the ISC license, the text of which
89 104
 is included within the package, or, at your option, you may relicense the work

+ 0
- 2
config.h.in View File

@@ -1,9 +1,7 @@
1 1
 #ifndef CONFIG_H
2 2
 #define CONFIG_H
3 3
 
4
-#define PROGRAM_NAME "${CMAKE_PROJECT_NAME}"
5 4
 #define PROGRAM_VERSION "${project_VERSION}"
6
-
7 5
 #define PLUGIN_DIR "${CMAKE_INSTALL_PREFIX}/${plugin_dir}"
8 6
 
9 7
 #endif  // ! CONFIG_H

+ 0
- 1
degesch.c View File

@@ -48,7 +48,6 @@ enum
48 48
 #define print_warning_data  ((void *) ATTR_WARNING)
49 49
 
50 50
 #include "config.h"
51
-#undef PROGRAM_NAME
52 51
 #define PROGRAM_NAME "degesch"
53 52
 
54 53
 #include "common.c"

+ 0
- 1
kike.c View File

@@ -19,7 +19,6 @@
19 19
  */
20 20
 
21 21
 #include "config.h"
22
-#undef PROGRAM_NAME
23 22
 #define PROGRAM_NAME "kike"
24 23
 
25 24
 #define WANT_SYSLOG_LOGGING

+ 2
- 0
zyklonb.c View File

@@ -19,6 +19,8 @@
19 19
  */
20 20
 
21 21
 #include "config.h"
22
+#define PROGRAM_NAME "ZyklonB"
23
+
22 24
 #include "common.c"
23 25
 
24 26
 // --- Configuration (application-specific) ------------------------------------

Loading…
Cancel
Save