home » zplus/clif.git
ID: 62743899ebc50490eeabe0e32b41b85a5408f626
56 lines — 2K — View raw


{% extends "index.html" %}

{% block menu_about_class %}selected{% endblock %}

{% block content %}

<p>
    <i>Welcome!</i> You have reached a public instance of the <i>CLI Forge</i>.
</p>

<p>
    This is a place for collaborative software development. It offers hosting for
    Git repositories and mailing lists, and it aims at being entirely usable from
    your CLI by leveraging existing tools and an email-driven workflow.
    Read on for a quick introduction to using this instace.
</p>

<br />

<p>
    <i>New users</i>
    <br />&nbsp;&nbsp;&nbsp;&nbsp;
    You only need an account if you wish to host your repositories on this instance.
    Collaboration is done on mailing lists and you don't need an account for that.
    When new users join the instance, they are automatically assigned the namespace
    <code>/&lt;username&gt;</code> under which they can add new repositories.<br />
    Since this instance is still under testing it is not currently open for public
    registrations, but you can still get an account by asking in #peers at irc.libera.chat.
</p>

<p>
    <i>Adding repositories</i>
    <br />&nbsp;&nbsp;&nbsp;&nbsp;
    If you have an account, you can use CLIF as a remote for sharing your repositories.
    Simply running <code>git clone git@{{ domain }}:&lt;namespace&gt;/&lt;repository&gt;</code>
    will create a new empty repository that you can add to your list of remotes.
</p>

<p>
    <i>Mailing lists</i>
    <br />&nbsp;&nbsp;&nbsp;&nbsp;
    Mailing lists are where collaboration happens, and they are stored in repositories
    too. All you have to do in order to create a new mailing list is to create
    a new repository with the suffix <code>.mlist</code>, for example
    <code>git clone git@{{ domain }}:alice/project.mlist</code>. CLIF then will
    begin accepting emails for <code>alice/project@{{ domain }}</code> and store
    them inside the <code>alice/project.mlist</code> repository.
    <br />
    New threads are created simply by sending a new email to the list address.
    An account is not required.
    It is also possible to join an existing thread by sending an email containing
    the header <code>In-Reply-To: &lt;Message-ID&gt;</code>, where <code>Message-ID</code>
    is the ID value of any previous message.
</p>

{% endblock %}