~brettgilio/orcircd-opam

orcircd-opam/docs/README.org -rw-r--r-- 2.8 KiB
9bce0392 — Brett Gilio Update LICENSE graphic. 1 year, 2 months ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# This file is used EXCLUSIVELY to generate Markdown used in the BASEDIR
#+title: opam
#+options: toc:nil
#+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 being developed, it has become apparent that many different
independent libraries need to be constructed to fulfill
implementations of various RFCs. These libraries are 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. This additional repository makes it
easier to obain development versions of relevant libraries where
API stablity is not guaranteed.

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]].

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 execute:

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

Next, add the repository.

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

Now set =orcircd-opam='s priority to be higher than the =default=
repository priority. This priority may be correctly set already.
You can evaluate =$ opam repo= to confirm or deny this condition.
If the priority of =orcircd-opam= is not set above =default=,
you can adjust the priority by replacing =<n>= with the correct value.

=$ opam repo priority orcircd-opam <n>=

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=
license. See [[./LICENSE][LICENSE]] for more details.

#+NAME: license
#+begin_export html
 <img src="https://orcircd.org/image/cc-zero.svg" alt="CC0" width="155" height="55">
#+end_export


* COMMENT Local variables
# Local Variables:
# eval: (setq org-html-text-markup-alist '((strike-through . "~~%s~~")))
# eval: (add-hook 'after-save-hook #'org-md-export-to-markdown nil t)
# End: