From f1637a80e34d0517c6467a6f3073e4e39729372b Mon Sep 17 00:00:00 2001
From: Daniel Vedder <daniel.vedder@idiv.de>
Date: Fri, 25 Nov 2022 09:59:12 +0100
Subject: [PATCH] Updated editors.md
---
README.md | 5 ++---
docs/editors.md | 23 +++++++++++++++++------
2 files changed, 19 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index 60b723f..62d9620 100644
--- a/README.md
+++ b/README.md
@@ -16,7 +16,7 @@ It is currently in the very early stages of development.
Install the latest version of the [Julia](https://julialang.org/downloads/) programming
language. The recommended editors are [VSCode](https://www.julia-vscode.org/) or
[Emacs](https://www.emacswiki.org/emacs/JuliaProgrammingLanguage) (see `docs/editors.md`).
-To install package dependencies, open a Julia REPL and run
+To install package dependencies, open a Julia REPL in this folder and run
`using Pkg; Pkg.activate("."); Pkg.instantiate()`.
Run the simulation by executing `run.jl` from the commandline, or loading it from
@@ -26,5 +26,4 @@ This model uses the [Agents.jl](https://juliadynamics.github.io/Agents.jl/stable
---
-© 2022 Daniel Vedder, Lea Kolb
-MIT license
+© 2022 Daniel Vedder, Lea Kolb (MIT license)
diff --git a/docs/editors.md b/docs/editors.md
index 6073999..2f40603 100644
--- a/docs/editors.md
+++ b/docs/editors.md
@@ -13,17 +13,13 @@ There are a couple of addons that make working with Julia much nicer in Emacs:
then install vterm itself with `M-x package-install vterm`, *before* you can do
`M-x package-install julia-snail`. Then add it to your `init.el` with
`(require 'julia-snail)` and `(add-hook 'julia-mode-hook #'julia-snail-mode)`.
-
-3. [`Revise.jl`](https://timholy.github.io/Revise.jl/stable/) allows one to reload code
- without restarting the Julia interpreter. Get it with `Pkg.add("Revise")`, then
- add `using Revise` to `.julia/config/startup.jl` to have it automatically available.
-4. [`company-mode`](http://company-mode.github.io/) integrates with Snail to give code
+3. [`company-mode`](http://company-mode.github.io/) integrates with Snail to give code
completion. Install with `M-x package-install company`, then add
`(add-hook 'julia-mode-hook #'company-mode)` and
`(global-set-key (kbd "C-<tab>") 'company-complete)` to your `init.el`.
-5. [`magit`](https://magit.vc/) is a great git interface for Emacs. Install with
+4. [`magit`](https://magit.vc/) is a great git interface for Emacs. Install with
`M-x package-install magit` and add `(global-set-key (kbd "C-x g") 'magit-status)`
to your `init.el`.
@@ -32,3 +28,18 @@ There are a couple of addons that make working with Julia much nicer in Emacs:
See [here](https://www.julia-vscode.org/).
*TODO: add more detail.*
+
+
+## Other useful stuff
+
+1. [`Revise.jl`](https://timholy.github.io/Revise.jl/stable/) allows one to reload code
+ without restarting the Julia interpreter. Get it with `Pkg.add("Revise")`, then
+ add `using Revise` to `.julia/config/startup.jl` to have it automatically available.
+
+2. [`git-bug`](https://github.com/MichaelMure/git-bug) is a commandline bug tracker that
+ integrates directly with git. It can also be used as a local interface to Gitlab issues.
+ To install on Linux, download the [binary](https://github.com/MichaelMure/git-bug/releases/tag/v0.8.0),
+ copy it to `/usr/local/bin/git-bug`, and set it as executable with `chmod +x
+ /usr/local/bin/git-bug`. To set up Gitlab integration, run `git bug bridge configure`
+ from within the relevant repository.
+
--
GitLab