Add telodendria-changelog; prepare for v0.1.0

This commit is contained in:
Jordan Bancino 2022-12-13 15:59:40 +00:00
parent 043109958f
commit a3502adf57
4 changed files with 59 additions and 43 deletions

View file

@ -0,0 +1,41 @@
.Dd $Mdocdate: December 13 2022 $
.Dt TELODENDRIA-CHANGELOG 7
.Os Telodendria Project
.Sh NAME
.Nm Telodendria
.Nd The change log for the Telodendria project.
.Sh PROJECT STATUS
.Pp
.Nm
is a very ambitious project. There's a lot that needs to happen yet
before it is usable. At the moment,
.Nm
is starting to resemble a Matrix homeserver, but you can't really
call it one yet. The foundation is mostly in place; now there's the
Matrix specification to implement.
.Pp
Just because there's not much here yet doesn't mean you should go
away! I could always use help, so you are more than welcome to get
involved in the project if you want to see things move quicker.
Feel free to donate using the links on the project website, or
see the
.Xr contributing 7
page for details on how to get involved. The CVS repository has
a file called
.Pa TODO.txt ,
which contains a checklist of the items that need to be completed.
Feel free to grab an item on that list and start writing patches!
It's a good idea to join the Matrix rooms noted in
.Xr telodendria 7
as well, so you can discuss your progress and ask questions.
.Sh v0.1.0
.Pp
Not released yet.
.Pp
This is the first public release of
.Nm
so there are no changes to report. Future releases will
have a complete change log entry here.
.Pp
This is a symbolic release targeted at developers, so there's nothing
useful for ordinary users yet. Stay tuned for future releases though!

View file

@ -1,4 +1,4 @@
.Dd $Mdocdate: November 20 2022 $
.Dd $Mdocdate: December 13 2022 $
.Dt TELODENDRIA 7
.Os Telodendria Project
.Sh NAME
@ -9,13 +9,6 @@
is an open source Matrix homeserver written entirely from scratch in ANSI C and
designed to be lightweight and simple, yet functional.
.Pp
.Sy Note:
.Nm
is under
.Sy heavy
development and is not yet ready for use. Please see
.Sx PROJECT STATUS .
.Pp
.Nm
differentiates itself from the other Matrix homeserver
implementations because it:
@ -169,22 +162,6 @@ shouldn't have a hostile leader. I want to be as understanding as I can, and tal
through issues politely and in a civil manner. If I'm failing in this way, don't
be afraid to call me out!
.El
.Sh PROJECT STATUS
Telodendria is a very ambitious project. There's a lot that needs to happen yet
before it is usable. At the moment, there's nothing here that even remotely resembles
a Matrix homeserver. I'm still getting off the ground and building a foundation.
.Pp
But just because there's nothing here yet doesn't mean you should go away! I could
always use help, so you are more than welcome to help out if you want things to go
quicker. Please see the
.Xr contributing 7
page for details on how you can get involved. The CVS repository has a file called
.Pa TODO.txt ,
which contains a checklist of what has been done so far, and what's on the radar
to be done. You can take a look at it once you've checked out the source code.
If you'd like to help out, feel free to grab an item on the list that's not done
yet and start getting patches written. When you're done, enjoy the satisfaction
of crossing the item off the list yourself.
.Sh SEE ALSO
.Xr telodendria 8 ,
.Xr telodendria.conf 5 ,
@ -195,25 +172,17 @@ The installed version of
conforms to the latest Matrix specification available at the time
of its release.
.Sh HISTORY
At this time,
.Pp
.Nm
does not have any tagged releases because it is not yet functional
as a Matrix homeserver. Please checkout out
.Sx PROJECT STATUS
to see where things are currently at. When
.Nm
is mature enough to have a change log, it will go in this section.
was started in early July of 2022. For a change log of this
project, see
.Xr telodendria-changelog 7 .
.Sh AUTHORS
.Nm
was started by Jordan Bancino <@jordan:bancino.net>.
Contributions to the code, website, documentation, or other
components of
.Nm
were made by the following people:
.Bl -bullet
.It
Jonah Evans <@jonah:bancino.net>
.El
was started by and is almost exclusively developed by
Jordan Bancino <@jordan:bancino.net>. Contributions to the code,
website, documentation, or other components of this project have
been made by various open source developers.
.Sh LICENSE
All of the code and documentation for
.Nm

View file

@ -35,7 +35,7 @@ functional.
<div class="msg-error">
<b><i>Note:</i></b> <b>Telodendria</b> is under <i>heavy</i> development and is not
yet ready for use.
Please see the <a href="/man/man7/telodendria.7.html#PROJECT_STATUS">Project Status</a>
Please see the <a href="/man/man7/telodendria-changelog.7.html#PROJECT_STATUS">Project Status</a>
for information about the project state, and use the links below to help fund development.
</div>
<h2 id="donate">Donate</h2>
@ -90,7 +90,7 @@ Signify
<tr>
<td colspan="4" style="text-align: center;">
No downloads here yet. See the
<a href="/man/man7/telodendria.7.html#PROJECT_STATUS">Project Status</a> for more
<a href="/man/man7/telodendria-changelog.7.html#PROJECT_STATUS">Project Status</a> for more
information.
</td>
</tr>
@ -154,6 +154,12 @@ Configuration file options.
Contributing guide.
</td>
</tr>
<tr>
<td><a href="man/man7/telodendria-changelog.7.html">telodendria-changelog(7)</a></td>
<td>
The change log for the Telodendria project.
</td>
</tr>
</table>
<p>
<details>

View file

@ -19,7 +19,7 @@
# such that these serve more as sane defaults than hard requirements.
#
: "${TELODENDRIA_VERSION:=0.0.0}"
: "${TELODENDRIA_VERSION:=0.1.0}"
: "${CVS_TAG:=Telodendria-$(echo $TELODENDRIA_VERSION | sed 's/\./_/g')}"
: "${DEFINES:=-D_DEFAULT_SOURCE -DTELODENDRIA_VERSION=\"$TELODENDRIA_VERSION\"}"