Skip to content

Commit

Permalink
README: Merge information from our previous Trac wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
Julien-Elie committed Sep 14, 2021
1 parent e376b55 commit 0fb3419
Showing 1 changed file with 47 additions and 11 deletions.
58 changes: 47 additions & 11 deletions readme.pod
@@ -1,22 +1,37 @@
=head1 Welcome to the InterNetNews project!

This is the current development version of S<INN 2.7>. This code is under
active development and may or may not be stable at any given time.
Contributions and bug reports are welcome and encouraged.
=head2 INN 2.7

Our C<main> branch is for the current development of the next S<INN 2.7>
major release. Head to the C<2.6> branch for the current stable release.

This code is under active development and may or may not be
stable at any given time. Contributions and bug reports are welcome
and encouraged.

This work is sponsored by Internet Systems Consortium.

The official homepage of the project is
L<https://www.isc.org/othersoftware/>.

Please see
L<INSTALL|https://www.eyrie.org/~eagle/software/inn/docs/install.html>
Please see:

=over 4

=item L<INSTALL|https://www.eyrie.org/~eagle/software/inn/docs/install.html>
for installation instructions,
L<NEWS|https://www.eyrie.org/~eagle/software/inn/docs/news.html>
for what's changed from the previous release, and

=item L<NEWS|https://www.eyrie.org/~eagle/software/inn/docs/news.html>
for what's changed from the previous release,

=item and
L<LICENSE|https://www.eyrie.org/~eagle/software/inn/docs/license.html>
for the copyright, license, and distribution terms. These files can
also be found in the F<doc/pod> directory if not present at top-level.
for the copyright, license, and distribution terms.

=back

These files can also be found in the F<doc/pod> directory if not present
at top-level.

=head1 What is INN?

Expand Down Expand Up @@ -169,7 +184,24 @@ Please don't send general questions to the above addresses; those
addresses are specifically for INN, and the INN maintainers usually won't
have time to answer general questions.

=head1 Contributing Code
=head1 Testing and Development

=head2 Source Code

INN is maintained using the Git version control system.
The official InterNetNews Git repository is located at
L<https://github.com/InterNetNews/inn>. A local copy of the current
development source can be obtained by cloning it using a Git client:

git clone https://github.com/InterNetNews/inn.git

You can also download L<daily
snapshots|https://archives.eyrie.org/software/inn/snapshots/> produced
only if the current code compiles and passes the test suite, so they
have undergone at least some basic validation, although they've not
been tested by a human.

=head2 Contributing Code

If you have a patch or a utility that you'd like to be considered for
inclusion into INN, please make a GitHub pull request, or alternatively
Expand All @@ -181,6 +213,10 @@ in the body of the message (not as an attachment because the mailing-list
might strip it), or put it on a webpage and send a link. Patches included
with a bug report as described above should follow the same procedure.

Please submit all patches against the current main branch, not against a
stable release. The development version of INN is often much different
than the last stable release.

Also please take a look at
L<HACKING|https://www.eyrie.org/~eagle/software/inn/docs/hacking.html>
for information about development and coding style.
Expand All @@ -194,7 +230,7 @@ to if you like. Some of them you must be a member of before you can send
mail to them (thank the spammers for that policy), and one of them is
read-only (no postings allowed).

=over 24
=over 8

=item inn-announce@lists.isc.org

Expand Down

0 comments on commit 0fb3419

Please sign in to comment.