picnoir/my-repo-pins
1
0
Fork 0
mirror of https://github.com/NinjaTrappeur/my-repo-pins.git synced 2024-06-02 03:24:09 +02:00
Code Issues Projects Releases Wiki Activity

Update readme

Browse source
This commit is contained in:
Félix Baylac-Jacqué 2022-04-04 18:31:59 +02:00
parent bac502397d
commit 384b952611
No known key found for this signature in database
GPG key ID: EFD315F31848DBA4
1 changed files with 25 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -1,2 +1,27 @@
# H.el [![CI](https://github.com/NinjaTrappeur/h.el/actions/workflows/test.yml/badge.svg)](https://github.com/NinjaTrappeur/h.el/actions/workflows/test.yml)
Project checkout and navigation Emacs package heavily inspired by [zimbatm/h](https://github.com/zimbatm/h).
**It's not ready yet. Come back later.**
TODO before first release:
- [ ] Replace `directory-files-recursively` with custom implemention. Support 'till Emacs 24.
- [ ] Implement GitHub fetcher.
- [ ] Implement GitLab fetcher.
- [ ] Implement sr.ht fetcher.
- [ ] Implement codeberg fetcher.
- [ ] Document how to implement a new fetcher.
- [ ] Explain what the hell this thing is about in readme.
# Setup
You'll have to setup
```elisp
(require 'h)
(setq h-code-root "~/code-root")
```
```elisp
(global-set-key (kbd "M-h") 'h-jump-to-project)
```