Commit 3fb5ee8e authored by Vivien Kraus's avatar Vivien Kraus
Browse files

Make an index

parent da720e0d
Pipeline #109721 passed with stages
in 7 minutes and 26 seconds
......@@ -18,9 +18,11 @@ make -j 16 install-html || exit 1
make distclean || exit 1
cd .. || exit 1
cp tarot-$VERSION/index.html public/ || exit 1
if test "x$CI_PAGES_URL" = "x"
then
export CI_PAGES_URL="http://play-tarot.frama.io/tarot"
export CI_PAGES_URL="https://play-tarot.frama.io/tarot"
fi
for link in $(wget -O- "$CI_API_V4_URL/projects/$CI_PROJECT_ID/releases" | jq -r '.[0].assets.links[].url')
......
......@@ -21,12 +21,14 @@ EXTRA_DIST += \
AUTHORS.org \
README.md \
README \
setup.el
setup.el \
index.html
MAINTAINERCLEANFILES += \
$(srcdir)/README.md \
$(srcdir)/README \
$(srcdir)/AUTHORS
$(srcdir)/AUTHORS \
$(srcdir)/index.html
org_verbose = $(org_verbose_@AM_V@)
org_verbose_ = $(org_verbose_@AM_DEFAULT_V@)
......@@ -47,3 +49,10 @@ $(srcdir)/AUTHORS: AUTHORS.org setup.el
--file "$(srcdir)/AUTHORS.org" \
-f org-ascii-export-to-ascii \
&& mv "$(srcdir)/AUTHORS.txt" "$(srcdir)/AUTHORS")
$(srcdir)/index.html: tarot.org setup.el
$(org_verbose) ($(EMACS) \
--batch -q \
-l "$(srcdir)/setup.el" \
--file "$(srcdir)/tarot.org" \
-f org-html-export-to-html \
&& mv "$(srcdir)/tarot.html" "$(srcdir)/index.html")
......@@ -4,17 +4,66 @@
#+options: toc:nil email:t
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="share/doc/tarot/style.css" />
This is the repository of the Tarot source code. Welcome!
You will most likely want to [[https://gugurumbe.frama.io/tarot/download.html][download]] the software.
* Download the software
You have several options.
** Use a supported package manager
Package managers are recommended since they let you stay up to date
with each release. Tarot tries to be available with as many package
managers as possible, however there are a few restrictions.
*** You're running GNU/Linux: Use Flatpak
Configure flatpak with these easy steps:
#+BEGIN_SRC shell :eval no
# Add the GNOME repo for the runtime dependencies; remove "--user" for
# system-wide installation.
flatpak --user remote-add --if-not-exists gnome \
https://sdk.gnome.org/gnome.flatpakrepo
# Add the tarot repo
flatpak --user remote-add --if-not-exists tarot \
https://play-tarot.frama.io/tarot-flatpak/tarot.flatpakrepo
# Install the package
flatpak --user install -y tarot eu.planete_kraus.Tarot
#+END_SRC
For developers: the Flatpak manifest is at
[[https://play-tarot.frama.io/tarot-flatpak/eu.planete_kraus.Tarot.json]].
It is updated with each release with a short delay.
*** Your favorite package manager is not listed here
Please tell me. There are a few restrictions on which package
managers are listed here:
- the package managers should be free software (/free/ as in
[[https://www.fsf.org/]]);
- the package manager should not build the package with a non-free
toolchain;
- the package manager should either be decentralized (it should be
possible to use it without its "main" archive) or its archive should
have a clear policy on accepting only free software.
** Download the latest release
The latest release is always available online at
[[https://play-tarot.frama.io/tarot/tarot-latest.tar.gz]]. Once
extracted, you should run:
You will find the usual =autogen.sh= to start building your
=configure= script, and then go all GNU!
#+BEGIN_SRC shell :eval no
./configure && make && sudo make install
#+END_SRC
If you don't know how to play tarot, then start with [[https://gugurumbe.frama.io/tarot/share/doc/tarot/tarot.html/index.html#Top][the online manual]]!
* Documentation
There are several sources of documentation. There is an online
version of the manual at
[[https://play-tarot.frama.io/tarot/share/doc/tarot/tarot.html/index.html#Top]].
There is a developer blog at
[[https://gugurumbe.frama.io/tarot/share/doc/tarot/blog/]].
Less interestingly, there is a developer blog at
[[https://play-tarot.frama.io/tarot/share/doc/tarot/blog/]].
If you have a bug, you don't understand something, or have a dream,
come and share it with me on the fediverse (=@vk@mamot.fr=) or by
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment