diff options
| author | Romain GARBAGE <romain.garbage@inria.fr> | 2025-09-01 09:54:39 +0200 |
|---|---|---|
| committer | Romain GARBAGE <romain.garbage@inria.fr> | 2025-09-01 14:14:30 +0200 |
| commit | a90bb01c67c8892277b683623c5569221c75a8cc (patch) | |
| tree | a23b5dc4d6e12a19e8a77bc4184c716ff10c5f5f | |
| parent | 8dcecffaf8cc2044d3dee74c327c421cd02b942c (diff) | |
README: Add link to Guix manual and fix syntax.
* README.rst: Add missing newlines for code blocks. Add link to
upstream Guix Packaging Guidelines.
| -rw-r--r-- | README.rst | 11 |
1 files changed, 10 insertions, 1 deletions
| @@ -70,14 +70,21 @@ for unfinished contributions with WIP. | |||
| 70 | When submitting a new package or a modification to a package, make sure to run: | 70 | When submitting a new package or a modification to a package, make sure to run: |
| 71 | 71 | ||
| 72 | .. code:: console | 72 | .. code:: console |
| 73 | |||
| 73 | guix lint -L /path/to/your/guix/science/checkout <package-name> | 74 | guix lint -L /path/to/your/guix/science/checkout <package-name> |
| 74 | 75 | ||
| 76 | This repository follows Guix's `Packaging Guidelines`_, refer to them | ||
| 77 | when contributing. | ||
| 78 | |||
| 79 | .. _Packaging Guidelines: | ||
| 80 | https://guix.gnu.org/manual/devel/en/html_node/Packaging-Guidelines.html | ||
| 81 | |||
| 75 | When obtaining a fresh checkout of this repository, run the following | 82 | When obtaining a fresh checkout of this repository, run the following |
| 76 | command: | 83 | command: |
| 77 | 84 | ||
| 78 | .. code:: console | 85 | .. code:: console |
| 79 | 86 | ||
| 80 | guix git authenticate b1fe5aaff3ab48e798a4cce02f0212bc91f423dc "CA4F 8CF4 37D7 478F DA05 5FD4 4213 7701 1A37 8446" | 87 | guix git authenticate b1fe5aaff3ab48e798a4cce02f0212bc91f423dc "CA4F 8CF4 37D7 478F DA05 5FD4 4213 7701 1A37 8446" |
| 81 | 88 | ||
| 82 | The command authenticates your checkout and installs Git hooks such that | 89 | The command authenticates your checkout and installs Git hooks such that |
| 83 | ``git pull`` and ``git push`` automatically authenticate it from there | 90 | ``git pull`` and ``git push`` automatically authenticate it from there |
| @@ -97,6 +104,7 @@ A new package definition can be added in the relevant module. | |||
| 97 | For example, after adding a package definition such as: | 104 | For example, after adding a package definition such as: |
| 98 | 105 | ||
| 99 | .. code:: scheme | 106 | .. code:: scheme |
| 107 | |||
| 100 | (define-public my-package-variable | 108 | (define-public my-package-variable |
| 101 | (package | 109 | (package |
| 102 | (name "my-package-name") | 110 | (name "my-package-name") |
| @@ -105,6 +113,7 @@ For example, after adding a package definition such as: | |||
| 105 | can be built using the following command: | 113 | can be built using the following command: |
| 106 | 114 | ||
| 107 | .. code:: console | 115 | .. code:: console |
| 116 | |||
| 108 | guix build -L /path/to/guix/science/checkout my-package-name | 117 | guix build -L /path/to/guix/science/checkout my-package-name |
| 109 | 118 | ||
| 110 | Note that generally the same string is used for the package name and | 119 | Note that generally the same string is used for the package name and |
