Browse Source

update readmes, add placeholder logo

tags/v2.7.0-rc1
Shivaram Lingamneni 2 years ago
parent
commit
f1ae8051cb
3 changed files with 31 additions and 32 deletions
  1. 6
    7
      README
  2. 14
    15
      README.md
  3. 11
    10
      irc/server.go

+ 6
- 7
README View File

1
-
2
-                                 ▄▄▄   ▄▄▄·  ▄▄ •        ▐ ▄       
3
-                           ▪     ▀▄ █·▐█ ▀█ ▐█ ▀ ▪▪     •█▌▐█▪     
4
-                            ▄█▀▄ ▐▀▀▄ ▄█▀▀█ ▄█ ▀█▄ ▄█▀▄▪▐█▐▐▌ ▄█▀▄ 
5
-                           ▐█▌.▐▌▐█•█▌▐█ ▪▐▌▐█▄▪▐█▐█▌ ▐▌██▐█▌▐█▌.▐▌
6
-                            ▀█▄▀▪.▀  ▀ ▀  ▀ ·▀▀▀▀  ▀█▄▀ ▀▀ █▪ ▀█▄▀▪
7
-
1
+   ___ _ __ __ _  ___  
2
+  / _ \ '__/ _` |/ _ \ 
3
+ |  __/ | | (_| | (_) |
4
+  \___|_|  \__, |\___/ 
5
+            __/ |      
6
+           |___/       
8
 -----------------------------------------------------------------------------------------------
7
 -----------------------------------------------------------------------------------------------
9
 
8
 
10
 Ergo is a modern IRC server written in Go. Its core design principles are:
9
 Ergo is a modern IRC server written in Go. Its core design principles are:

+ 14
- 15
README.md View File

1
-![Oragono logo](docs/logo.png)
1
+![Ergo logo](docs/logo.png)
2
 
2
 
3
-Oragono is a modern IRC server written in Go. Its core design principles are:
3
+Ergo (formerly known as Oragono) is a modern IRC server written in Go. Its core design principles are:
4
 
4
 
5
 * Being simple to set up and use
5
 * Being simple to set up and use
6
 * Combining the features of an ircd, a services framework, and a bouncer (integrated account management, history storage, and bouncer functionality)
6
 * Combining the features of an ircd, a services framework, and a bouncer (integrated account management, history storage, and bouncer functionality)
7
 * Bleeding-edge [IRCv3 support](https://ircv3.net/software/servers.html), suitable for use as an IRCv3 reference implementation
7
 * Bleeding-edge [IRCv3 support](https://ircv3.net/software/servers.html), suitable for use as an IRCv3 reference implementation
8
 * Highly customizable via a rehashable (i.e., reloadable at runtime) YAML config
8
 * Highly customizable via a rehashable (i.e., reloadable at runtime) YAML config
9
 
9
 
10
-Oragono is a fork of the [Ergonomadic](https://github.com/jlatt/ergonomadic) IRC daemon <3
10
+Ergo is a fork of the [Ergonomadic](https://github.com/jlatt/ergonomadic) IRC daemon <3
11
 
11
 
12
 ---
12
 ---
13
 
13
 
14
 [![Go Report Card](https://goreportcard.com/badge/github.com/oragono/oragono)](https://goreportcard.com/report/github.com/oragono/oragono)
14
 [![Go Report Card](https://goreportcard.com/badge/github.com/oragono/oragono)](https://goreportcard.com/report/github.com/oragono/oragono)
15
 [![Build Status](https://travis-ci.com/oragono/oragono.svg?branch=master)](https://travis-ci.com/oragono/oragono)
15
 [![Build Status](https://travis-ci.com/oragono/oragono.svg?branch=master)](https://travis-ci.com/oragono/oragono)
16
 [![Download Latest Release](https://img.shields.io/badge/downloads-latest%20release-green.svg)](https://github.com/oragono/oragono/releases/latest)
16
 [![Download Latest Release](https://img.shields.io/badge/downloads-latest%20release-green.svg)](https://github.com/oragono/oragono/releases/latest)
17
-[![Freenode #oragono](https://img.shields.io/badge/Freenode-%23oragono-1e72ff.svg?style=flat)](https://www.irccloud.com/invite?channel=%23oragono&hostname=irc.freenode.net&port=6697&ssl=1)
18
 [![Crowdin](https://d322cqt584bo4o.cloudfront.net/oragono/localized.svg)](https://crowdin.com/project/oragono)
17
 [![Crowdin](https://d322cqt584bo4o.cloudfront.net/oragono/localized.svg)](https://crowdin.com/project/oragono)
19
 
18
 
20
-If you want to take a look at a running Oragono instance or test some client code, feel free to play with [testnet.oragono.io](https://testnet.oragono.io/) (TLS on port 6697 or plaintext on port 6667).
19
+If you want to take a look at a running Ergo instance or test some client code, feel free to play with [testnet.ergo.chat](https://testnet.ergo.chat/) (TLS on port 6697 or plaintext on port 6667).
21
 
20
 
22
 ---
21
 ---
23
 
22
 
40
 * passwords stored with [bcrypt](https://godoc.org/golang.org/x/crypto)
39
 * passwords stored with [bcrypt](https://godoc.org/golang.org/x/crypto)
41
 * `UBAN`, a unified ban system that can target IPs, networks, masks, and registered accounts (`KLINE` and `DLINE` are also supported)
40
 * `UBAN`, a unified ban system that can target IPs, networks, masks, and registered accounts (`KLINE` and `DLINE` are also supported)
42
 * [IRCv3 support](https://ircv3.net/software/servers.html)
41
 * [IRCv3 support](https://ircv3.net/software/servers.html)
43
-* a focus on developing with [specifications](https://oragono.io/specs.html)
42
+* a focus on developing with [specifications](https://ergo.chat/specs.html)
44
 
43
 
45
 ## Quick start guide
44
 ## Quick start guide
46
 
45
 
47
-Download the latest release from this page: https://github.com/oragono/oragono/releases/latest
46
+Download the latest release from this page: https://github.com/ergochat/ergo/releases/latest
48
 
47
 
49
 Extract it into a folder, then run the following commands:
48
 Extract it into a folder, then run the following commands:
50
 
49
 
51
 ```sh
50
 ```sh
52
 cp default.yaml ircd.yaml
51
 cp default.yaml ircd.yaml
53
 vim ircd.yaml   # modify the config file to your liking
52
 vim ircd.yaml   # modify the config file to your liking
54
-oragono mkcerts
55
-oragono run     # server should be ready to go!
53
+ergo mkcerts
54
+ergo run     # server should be ready to go!
56
 ```
55
 ```
57
 
56
 
58
-**Note:** See the [productionizing guide in our manual](https://github.com/oragono/oragono/blob/master/docs/MANUAL.md#productionizing-with-systemd) for recommendations on how to run a production network, including obtaining valid TLS certificates.
57
+**Note:** See the [productionizing guide in our manual](https://github.com/ergochat/ergo/blob/master/docs/MANUAL.md#productionizing-with-systemd) for recommendations on how to run a production network, including obtaining valid TLS certificates.
59
 
58
 
60
 ### Platform Packages
59
 ### Platform Packages
61
 
60
 
81
 
80
 
82
 #### Building
81
 #### Building
83
 
82
 
84
-You'll need an [up-to-date distribution of the Go language for your OS and architecture](https://golang.org/dl/). Once you have that, just clone the repository and run `make build`. If everything goes well, you should now have an executable named `oragono` in the base directory of the project.
83
+You'll need an [up-to-date distribution of the Go language for your OS and architecture](https://golang.org/dl/). Once you have that, just clone the repository and run `make build`. If everything goes well, you should now have an executable named `ergo` in the base directory of the project.
85
 
84
 
86
 ## Configuration
85
 ## Configuration
87
 
86
 
88
 The default config file [`default.yaml`](default.yaml) helps walk you through what each option means and changes.
87
 The default config file [`default.yaml`](default.yaml) helps walk you through what each option means and changes.
89
 
88
 
90
-You can use the `--conf` parameter when launching Oragono to control where it looks for the config file. For instance: `oragono run --conf /path/to/ircd.yaml`. The configuration file also stores where the log, database, certificate, and other files are opened. Normally, all these files use relative paths, but you can change them to be absolute (such as `/var/log/ircd.log`) when running Oragono as a service.
89
+You can use the `--conf` parameter when launching Ergo to control where it looks for the config file. For instance: `ergo run --conf /path/to/ircd.yaml`. The configuration file also stores where the log, database, certificate, and other files are opened. Normally, all these files use relative paths, but you can change them to be absolute (such as `/var/log/ircd.log`) when running Ergo as a service.
91
 
90
 
92
 ### Logs
91
 ### Logs
93
 
92
 
98
 Passwords (for both `PASS` and oper logins) are stored using bcrypt. To generate encrypted strings for use in the config, use the `genpasswd` subcommand as such:
97
 Passwords (for both `PASS` and oper logins) are stored using bcrypt. To generate encrypted strings for use in the config, use the `genpasswd` subcommand as such:
99
 
98
 
100
 ```sh
99
 ```sh
101
-oragono genpasswd
100
+ergo genpasswd
102
 ```
101
 ```
103
 
102
 
104
 With this, you receive a blob of text which you can plug into your configuration file.
103
 With this, you receive a blob of text which you can plug into your configuration file.
105
 
104
 
106
 ### Nickname and channel registration
105
 ### Nickname and channel registration
107
 
106
 
108
-Oragono relies heavily on user accounts to enable its distinctive features (such as allowing multiple clients per nickname). As a user, you can register your current nickname as an account using `/msg NickServ register <password>`. Once you have done so, you should [enable SASL in your clients](https://freenode.net/kb/answer/sasl), ensuring that you will be automatically logged into your account on each connection. This will prevent [problems claiming your registered nickname](https://github.com/oragono/oragono/blob/master/docs/MANUAL.md#nick-equals-account).
107
+Ergo relies heavily on user accounts to enable its distinctive features (such as allowing multiple clients per nickname). As a user, you can register your current nickname as an account using `/msg NickServ register <password>`. Once you have done so, you should [enable SASL in your clients](https://freenode.net/kb/answer/sasl), ensuring that you will be automatically logged into your account on each connection. This will prevent [problems claiming your registered nickname](https://github.com/ergochat/ergo/blob/master/docs/MANUAL.md#nick-equals-account).
109
 
108
 
110
 Once you have registered your nickname, you can use it to register channels:
109
 Once you have registered your nickname, you can use it to register channels:
111
 
110
 
121
 * Edmund Huber (2014-2015)
120
 * Edmund Huber (2014-2015)
122
 * Daniel Oaks (2016-present)
121
 * Daniel Oaks (2016-present)
123
 * Shivaram Lingamneni (2017-present)
122
 * Shivaram Lingamneni (2017-present)
124
-* [Many other contributors and friends of the project <3](https://github.com/oragono/oragono/blob/master/CHANGELOG.md)
123
+* [Many other contributors and friends of the project <3](https://github.com/ergochat/ergo/blob/master/CHANGELOG.md)

+ 11
- 10
irc/server.go View File

1053
 }
1053
 }
1054
 
1054
 
1055
 var (
1055
 var (
1056
-	infoString1 = strings.Split(`      ▄▄▄   ▄▄▄·  ▄▄ •        ▐ ▄
1057
-▪     ▀▄ █·▐█ ▀█ ▐█ ▀ ▪▪     •█▌▐█▪
1058
- ▄█▀▄ ▐▀▀▄ ▄█▀▀█ ▄█ ▀█▄ ▄█▀▄▪▐█▐▐▌ ▄█▀▄
1059
-▐█▌.▐▌▐█•█▌▐█ ▪▐▌▐█▄▪▐█▐█▌ ▐▌██▐█▌▐█▌.▐▌
1060
- ▀█▄▀▪.▀  ▀ ▀  ▀ ·▀▀▀▀  ▀█▄▀ ▀▀ █▪ ▀█▄▀▪
1061
-
1062
-         https://ergo.chat/
1063
-   https://github.com/ergochat/ergo
1064
-   https://crowdin.com/project/oragono
1065
-`, "\n")
1056
+	infoString1 = []string{
1057
+		"   ___ _ __ __ _  ___  ",
1058
+		"  / _ \\ '__/ _` |/ _ \\ ",
1059
+		" |  __/ | | (_| | (_) |",
1060
+		`  \___|_|  \__, |\___/ `,
1061
+		"            __/ |      ",
1062
+		"           |___/       ",
1063
+		"",
1064
+		"    https://ergo.chat/",
1065
+		"https://github.com/ergochat/ergo ",
1066
+	}
1066
 	infoString2 = strings.Split(`    Daniel Oakley,          DanielOaks,    <daniel@danieloaks.net>
1067
 	infoString2 = strings.Split(`    Daniel Oakley,          DanielOaks,    <daniel@danieloaks.net>
1067
     Shivaram Lingamneni,    slingamn,      <slingamn@cs.stanford.edu>
1068
     Shivaram Lingamneni,    slingamn,      <slingamn@cs.stanford.edu>
1068
 `, "\n")
1069
 `, "\n")

Loading…
Cancel
Save