Update readme

Julien LepillerMon Jun 21 14:54:43+0200 2021

86dace5

Update readme

README.md

11
More packages for the Guix package manager! This repository contains
22
recipes for packages that I am working on. They will eventually be sent
3-
upstream. When this is the case, they will vanish from this repo.
3+
upstream. When this is the case, they will vanish from this repository.
4+
Note that most of these packages are WIP and might not work very well, or might
5+
not even build. Your help is very welcome!
46
57
This repository should only contain free software.  If you encounter non-free
6-
software, please open an issue, email me or ping me on IRC (roptat on freenode).
8+
software, please open an issue, email me or ping me on IRC (roptat on libera.chat).
79
810
How to use these packages?
911
==========================
1012
11-
```sh
12-
export GUIX_PACKAGE_PATH=$HOME/guix-more
13-
```
14-
15-
That's it!
16-
17-
What is in there?
18-
=================
19-
20-
Binary analysis software
21-
------------------------
2213
23-
* _angr_: A binary analysis tool
14+
This is a Guix channel. You will first need to install
15+
[Guix](https://www.gnu.org/software/guix/download/) itself. Then, simply create
16+
a new `~/.config/guix/channels.scm` file with this content, or update the
17+
file with the additional channel if it already exists:
2418
25-
Education
26-
---------
27-
28-
* _morji_: A spaced-repetition program
29-
30-
Java
31-
----
19+
```scheme
20+
(cons* (channel
21+
        (name 'guix-android)
22+
        (url "https://git.lepiller.eu/git/guix-more.git"))
23+
       %default-channels)
24+
```
3225
33-
* _fop_: A print formatter driven by XSL formatting objects
26+
Then run `guix pull` to pull the new channel.
3427
35-
Openstreetmap
36-
-------------
28+
### Important checks ###
3729
38-
* _josm_: An openstreetmap editor
39-
* _imposm_: A script to import data from OSM to a postgis database
40-
* _tegola_: A program to produce vector tiles from a postgis database
30+
Make sure your guix environment is set up properly. You need to have
31+
`~/.config/guix/current` as the **first** item in your `$PATH` or you're going
32+
to run into troubles. Additionally, after running `guix pull`, make sure you
33+
run `hash guix` in any open terminal to make sure bash's cache is cleared of
34+
the old guix binary location.
4135
4236
Current work
4337
============
4438
45-
Using skia with icecat
46-
----------------------
39+
Adding Scala and SBT
40+
--------------------
4741
48-
Currently working on this. I have skia, but it requires some tricks to actually
49-
have icecat build with it.
42+
Scala is not bootstrappable, so it will not go into Guix easily.  In this repo,
43+
I rebuild Scala using the official Scala binary, and manage to build SBT using
44+
it.  Note that I only packaged sbt-launcher, which is what you get when you
45+
download sbt from their website.  Its role is to download and execute the
46+
full version of sbt from the repositories.
5047
51-
Adding gradle and scala/sbt
52-
---------------------------
48+
Adding Gradle
49+
-------------
5350
5451
Gradle is a build system used mostly by android applications. I have packages
55-
for 2/3 of gradle, but that's not enough. I'm currently blocked at a gradle
56-
subproject that requires scala and sbt. Scala is written in scala, so it's hard
57-
to bootstrap. I've packaged a binary version for now and building sbt (another
58-
dependency) is my next target.
59-
60-
Adding a maven-build-system
61-
---------------------------
62-
63-
Although the maven package is now in Guix proper, we do not have a maven-build-system
64-
yet. Such a build system requires maven and some plugins. I'm planning to build
65-
these plugins. They require a lot of new dependencies for which we can't use
66-
the maven-build-system either... Such a pain :/
67-
68-
OCaml and Coq packages
69-
----------------------
70-
71-
The more the better. They are being integrated.
72-
73-
TODO
74-
====
52+
for 2/3 of gradle in the past, but the project evolved quickly since then, so
53+
I will have to restart from the beginning.
7554
76-
Eiffel studio -> eiffel -> AutoProof and Eve -> boogie.
55+
Other Packages
56+
--------------
7757
78-
alt-ergo, CVC4
58+
As the name suggests, this channel contains more packages that I plan to upstream
59+
at some point, when I have time.