From e69b927ec32d0fe62a60a8f859787a8d4d56b619 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Ne=C4=8Dada?= Date: Fri, 10 Jun 2022 12:43:16 +0300 Subject: [PATCH] List of public mirrors --- Doxyfile | 2 +- MIRRORS.md | 14 ++++++++++++++ README.md | 18 ++++++++++++------ 3 files changed, 27 insertions(+), 7 deletions(-) create mode 100644 MIRRORS.md diff --git a/Doxyfile b/Doxyfile index 615ee54..4d67520 100644 --- a/Doxyfile +++ b/Doxyfile @@ -753,7 +753,7 @@ WARN_LOGFILE = # spaces. # Note: If this tag is empty the current directory is searched. -INPUT = qpms notes misc finite_systems.md CLIUTILS.md README.md README.Triton.md finite_systems.md lattices.md TODO.md +INPUT = qpms notes misc finite_systems.md MIRRORS.md CLIUTILS.md README.md README.Triton.md finite_systems.md lattices.md TODO.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses diff --git a/MIRRORS.md b/MIRRORS.md new file mode 100644 index 0000000..1216059 --- /dev/null +++ b/MIRRORS.md @@ -0,0 +1,14 @@ +QPMS source code mirrors +======================== + +QPMS source code is available at several locations; in all of the following, +upstream `master` branch is kept up-to-date. Various development branches +are not necessarily pushed everywhere (and they should be considered +unstable in the sense that rebases and forced pushes are possible). + +mirror | note | provider | backend +----------------------------------------------- | ----------------------- | ------------------------------------------------- | ------ + | primary public upstream | [repo.or.cz](https://repo.or.cz/) | girocco + | | [Codeberg](https://codeberg.org) | gitea + | | [Pirate Party Finland](https://piraattipuolue.fi) | gitea + | | [Aalto University](https://aalto.fi) | gitlab diff --git a/README.md b/README.md index 355cf17..064694f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ QPMS README =========== -QPMS (standing for QPMS Photonic Multiple Scattering) +[QPMS][homepage] (standing for QPMS Photonic Multiple Scattering) is a toolkit for frequency-domain simulations of photonic systems consisting of compact objects (particles) inside a homogeneous medium. Scattering properties of the individual particles are described by their T-matrices @@ -43,7 +43,8 @@ Infinite systems (lattices) Getting the code ================ -The main upstream public repository is located at . +The codebase is available at the main upstream public repository + or any of the [maintained mirrors][MIRRORS]. Just clone the repository with `git` and proceed to the installation instructions below. @@ -96,10 +97,14 @@ in [another document][INSTALL-ANDROID]. Documentation ============= -Documentation of QPMS is a work in progress. Most of the newer code -is documented using [doxygen][] comments. To build the documentation, just run +[QPMS documentation][homepage] is a work in progress. Most of the newer code +is documented using [doxygen][] comments. Documentation generated for the +upstream version is hosted on the QPMS homepage . + +To build the documentation yourself, +just run `doxygen` -in the root directory; the documentation will then be found in +in the QPMS source root directory; the documentation will then be found in `docs/html/index.html`. Of course, the prerequisite of this is having doxygen installed. @@ -169,7 +174,7 @@ You are also warmly welcome to the [QPMS user chat][telegramchat] in Telegram! - +[homepage]: https://qpms.necada.org [SCUFF-EM]: https://homerreid.github.io/scuff-em-documentation/ [OpenBLAS]: https://www.openblas.net/ [GSL]: https://www.gnu.org/software/gsl/ @@ -184,3 +189,4 @@ in Telegram! [telegramchat]: https://t.me/QPMScattering [authormail]: mailto:marek@necada.org [cliutils]: CLIUTILS.md +[MIRRORS]: MIRRORS.md