~brettgilio/orcircd-opam

633e627daada20b05adcc48bf6b99f29f2cc4903 — Brett Gilio 1 year, 1 month ago e13b675
More detail in README
2 files changed, 92 insertions(+), 0 deletions(-)

M README.md
M docs/README.org
M README.md => README.md +47 -0
@@ 2,6 2,53 @@

# orcircd-opam

A modern, high-performance IRC server (ircd) [opam repository]


## Purpose

As [orcircd](https://sr.ht/~brettgilio/orcircd/) is developed it became apparent that many different
independent libraries would have to be constructed to fulfill
implementations for various RFCs. These libraries were created
to not only fulfill the needs of `orcircd`, but also to be
contributed back to the general OCaml ecosystem.

Much of the OCaml ecosystem is centered around [opam](https://opam.ocaml.org/) which facilitates
the package management of OCaml for both development workflows, and
general end-user use-cases.

While the intent of the `orcircd` development team is to contribute
as much of the project back to the OCaml ecosystem as possible, there
may be lag between releases of different components propagating
to the main `opam` repository. As such, development may be best
fit by having an additional repository available to traverse this gap.

This repository tracks the packages *specific* to `orcircd`. No other
OCaml packages will be made available through this channel. It is
intended solely for use by the `orcircd` development team.


## Use

To establish this repository within `opam`, ensure that you already
have `opam` and the OCaml toolchain available on your system. This includes
having `opam` initialized as detailed in [HACKING](https://git.sr.ht/~brettgilio/orcircd/tree/master/HACKING.md).

Next, navigate to the `orcircd` directory and establish the repository.
If you initialized `opam` with `--enable-shell-hook` you may proceed
to the next step, otherwise:

`$ opam switch <name-of-orcircd-switch>`

followed by

`$ opam repo add orcircd-repo https://orcircd.org/opam/development`

Last, you will need to update your repository databases and apply
any available upgrades.

`$ opam update && opam upgrade`


## License


M docs/README.org => docs/README.org +45 -0
@@ 4,6 4,51 @@
#+export_file_name: ../README.md

* orcircd-opam
A modern, high-performance IRC server (ircd) [opam repository]


** Purpose
As [[https://sr.ht/~brettgilio/orcircd/][orcircd]] is developed it became apparent that many different
independent libraries would have to be constructed to fulfill
implementations for various RFCs. These libraries were created
to not only fulfill the needs of =orcircd=, but also to be
contributed back to the general OCaml ecosystem.

Much of the OCaml ecosystem is centered around [[https://opam.ocaml.org/][opam]] which facilitates
the package management of OCaml for both development workflows, and
general end-user use-cases.

While the intent of the =orcircd= development team is to contribute
as much of the project back to the OCaml ecosystem as possible, there
may be lag between releases of different components propagating
to the main =opam= repository. As such, development may be best
fit by having an additional repository available to traverse this gap.

This repository tracks the packages /specific/ to =orcircd=. No other
OCaml packages will be made available through this channel. It is
intended solely for use by the =orcircd= development team.


** Use
To establish this repository within =opam=, ensure that you already
have =opam= and the OCaml toolchain available on your system. This includes
having =opam= initialized as detailed in [[https://git.sr.ht/~brettgilio/orcircd/tree/master/HACKING.md][HACKING]].

Next, navigate to the =orcircd= directory and establish the repository.
If you initialized =opam= with =--enable-shell-hook= you may proceed
to the next step, otherwise:

=$ opam switch <name-of-orcircd-switch>=

followed by

=$ opam repo add orcircd-repo https://orcircd.org/opam/development=

Last, you will need to update your repository databases and apply
any available upgrades.

=$ opam update && opam upgrade=


** License
This database is made available under the terms of the =CC0 1.0 Universal=