|
| 1 | +[](https://www.gnu.org/licenses/gpl-3.0) |
| 2 | +[](https://jcs-emacs.github.io/jcs-elpa/#/sideline-geiser) |
| 3 | + |
1 | 4 | # sideline-geiser
|
2 |
| -Show Geiser result with sideline |
| 5 | +> Show Geiser result with sideline |
| 6 | +
|
| 7 | +[](https://github.com/emacs-sideline/sideline-geiser/actions/workflows/test.yml) |
| 8 | + |
| 9 | +## 🔨 Quickstart |
| 10 | + |
| 11 | +```elisp |
| 12 | +(use-package geiser |
| 13 | + :init |
| 14 | + (setq geiser-mode-eval-to-buffer-transformer #'sideline-geiser-show)) |
| 15 | +
|
| 16 | +(use-package sideline-geiser |
| 17 | + :init |
| 18 | + (setq sideline-backends-right '(sideline-geiser))) |
| 19 | +``` |
| 20 | + |
| 21 | +## 🛠️ Contribute |
| 22 | + |
| 23 | +[](http://makeapullrequest.com) |
| 24 | +[](https://github.com/bbatsov/emacs-lisp-style-guide) |
| 25 | +[](https://www.paypal.me/jcs090218) |
| 26 | +[](https://www.patreon.com/jcs090218) |
| 27 | + |
| 28 | +If you would like to contribute to this project, you may either |
| 29 | +clone and make pull requests to this repository. Or you can |
| 30 | +clone the project and establish your own branch of this tool. |
| 31 | +Any methods are welcome! |
| 32 | + |
| 33 | +### 🔬 Development |
| 34 | + |
| 35 | +To run the test locally, you will need the following tools: |
| 36 | + |
| 37 | +- [Eask](https://emacs-eask.github.io/) |
| 38 | +- [Make](https://www.gnu.org/software/make/) (optional) |
| 39 | + |
| 40 | +Install all dependencies and development dependencies: |
| 41 | + |
| 42 | +```sh |
| 43 | +$ eask install-deps --dev |
| 44 | +``` |
| 45 | + |
| 46 | +To test the package's installation: |
| 47 | + |
| 48 | +```sh |
| 49 | +$ eask package |
| 50 | +$ eask install |
| 51 | +``` |
| 52 | + |
| 53 | +To test compilation: |
| 54 | + |
| 55 | +```sh |
| 56 | +$ eask compile |
| 57 | +``` |
| 58 | + |
| 59 | +**🪧 The following steps are optional, but we recommend you follow these lint results!** |
| 60 | + |
| 61 | +The built-in `checkdoc` linter: |
| 62 | + |
| 63 | +```sh |
| 64 | +$ eask lint checkdoc |
| 65 | +``` |
| 66 | + |
| 67 | +The standard `package` linter: |
| 68 | + |
| 69 | +```sh |
| 70 | +$ eask lint package |
| 71 | +``` |
| 72 | + |
| 73 | +*📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.* |
| 74 | + |
| 75 | +## ⚜️ License |
| 76 | + |
| 77 | +This program is free software; you can redistribute it and/or modify |
| 78 | +it under the terms of the GNU General Public License as published by |
| 79 | +the Free Software Foundation, either version 3 of the License, or |
| 80 | +(at your option) any later version. |
| 81 | + |
| 82 | +This program is distributed in the hope that it will be useful, |
| 83 | +but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 84 | +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 85 | +GNU General Public License for more details. |
| 86 | + |
| 87 | +You should have received a copy of the GNU General Public License |
| 88 | +along with this program. If not, see <https://www.gnu.org/licenses/>. |
| 89 | + |
| 90 | +See [`LICENSE`](./LICENSE) for details. |
0 commit comments