Skip to content

Commit

Permalink
Use a dedicated CHANGELOG file
Browse files Browse the repository at this point in the history
  • Loading branch information
doronbehar committed Jul 12, 2020
1 parent 567a1b1 commit d4d8654
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 24 deletions.
33 changes: 33 additions & 0 deletions NEWS.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
= Change Log / News

== 0.1.3

Dependencies were updated to their latest, thanks to
https://renovate.whitesourcesoftware.com/[renovate] for the reminder, and a
small bug in config file parsing was fixed,
(https://github.com/doronbehar/pistol/issues/31[#31]).

== 0.1

https://github.com/doronbehar/pistol/releases[v0.1] Introduced a breaking
change to the config format, which you may have experienced when using Pistol
with a custom command:

....
[bat error]: '%pistol-filename%': No such file or directory (os error 2)
....

Basically, after hitting
https://github.com/doronbehar/pistol/issues/16[issue #16], I realised
that the old way Pistol substituted the file name in your config was not
scalable. So now, please replace every occurrence of `%s` with
`%pistol-filename%`. Or with:

[source,sh]
----
sed -i 's/%s/%pistol-filename%/g' ~/.config/pistol/pistol.conf
----

If you want to know more details, read
https://github.com/doronbehar/pistol/issues/16#issuecomment-614471555[this].

28 changes: 4 additions & 24 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,30 +1,6 @@
= Pistol
:toc:

=== NOTE TO EXISTING USERS

If you’ve updated to https://github.com/doronbehar/pistol/releases[v0.1]
or higher, you may experience errors with custom commands set in your
config, similar to:

....
[bat error]: '%pistol-filename%': No such file or directory (os error 2)
....

Basically, after hitting
https://github.com/doronbehar/pistol/issues/16[issue #16], I realised
that the old way Pistol substituted the file name in your config was not
scalable. So now, please replace every occurrence of `%s` with
`%pistol-filename%`. Or with:

[source,sh]
----
sed -i 's/%s/%pistol-filename%/g' ~/.config/pistol/pistol.conf
----

If you want to know more details, read
https://github.com/doronbehar/pistol/issues/16#issuecomment-614471555[this].

== Introduction

Pistol is a file previewer for command line file managers such as
Expand Down Expand Up @@ -416,3 +392,7 @@ env PISTOL_DEBUG=1 pistol test-file
----

And you should be able to see messages that may give you a clue.

== NEWS

See xref:./NEWS.adoc[NEWS].

0 comments on commit d4d8654

Please sign in to comment.