Commit graph

41 commits

Author SHA1 Message Date
Tim Culverhouse
67ded18fb6 readme: make contribution section more obvious
Move link to contribution guidelines to it's own section in README.

Fixes: 8c64bda5a0 ("doc: add contribution guidelines including code style")
Signed-off-by: Tim Culverhouse <tim@timculverhouse.com>
Acked-by: Robin Jarry <robin@jarry.cc>
2022-08-06 23:12:24 +02:00
Moritz Poldrack
8c64bda5a0 doc: add contribution guidelines including code style
The Linux kernel code style rules have been used as a well-tested basis
and sections pertaining C-specific rules – such as macros – have been
removed. For it a short section on the used formatter is added for
further reference.

Link: https://www.kernel.org/doc/html/v5.19-rc8/process/coding-style.html
Signed-off-by: Moritz Poldrack <git@moritz.sh>
Signed-off-by: Robin Jarry <robin@jarry.cc>
2022-08-05 21:57:12 +02:00
Moritz Poldrack
602a5778e8 go: bumped minimum required version 1.16
Due to github.com/daixiang0/gci requiring io/fs, the minimum required
Go version for aerc needs to be bumped to 1.16

Signed-off-by: Moritz Poldrack <git@moritz.sh>
Signed-off-by: Robin Jarry <robin@jarry.cc>
2022-08-05 21:55:26 +02:00
Moritz Poldrack
1b4b225318 lint: add information about false positive on missing notmuch
Signed-off-by: Moritz Poldrack <moritz@poldrack.dev>
Acked-by: Robin Jarry <robin@jarry.cc>
2022-08-04 21:58:09 +02:00
Robin Jarry
45e6e89b24 Add changelog
Git history is not for everyone. Let's introduce a user-oriented change
log. Ideally, this file should be updated incrementally when adding
a new feature. I have added contributors guidelines in README.md.

Update release.sh to automatically generate the release tag message with
the unreleased changes from the changelog.

Link: https://keepachangelog.com/en/1.0.0/
Signed-off-by: Robin Jarry <robin@jarry.cc>
2022-07-26 23:28:43 +02:00
Robin Jarry
98c9d7bb78 readme: add ~rjarry/aerc-discuss@lists.sr.ht in resources
Add a reference to a new end-user discussion list.

Signed-off-by: Robin Jarry <robin@jarry.cc>
Reviewed-by: Moritz Poldrack <moritz@poldrack.dev>
2022-03-24 12:25:42 +01:00
Robin Jarry
aab19262d2 readme: add links to documentation
Let's make it easier for new users to find information.

Signed-off-by: Robin Jarry <robin@jarry.cc>
Reviewed-by: Moritz Poldrack <moritz@poldrack.dev>
2022-03-24 12:25:07 +01:00
Robin Jarry
c82f248865 readme: fix typo
Fixes: 7e6c0d2e6e ("readme: add more details about the review process")
Signed-off-by: Robin Jarry <robin@jarry.cc>
2022-03-21 22:15:02 +01:00
Daniel Patterson
0cfffaef54 config: specify sharedir during build
We should use the Makefile value of SHAREDIR when searching for config
files and templates etc.

This is important for systems which do not use the standard file
hierarchy or which do not have a consistent location for installing
program files, for example NixOS, which will have a different install
location with every update.

Signed-off-by: Daniel Patterson <me@danielpatterson.dev>
Acked-by: Robin Jarry <robin@jarry.cc>
2022-03-03 21:31:32 +01:00
Robin Jarry
7e6c0d2e6e readme: add more details about the review process
* All patches must be signed-off.
* All patches must receive at least one independent review and approval
  before being applied.
* Remove the --in-reply-to= option for git send-email. This breaks
  lists.sr.ht UI.

Signed-off-by: Robin Jarry <robin@jarry.cc>
Acked-by: akspecs <akspecs@gmail.com>
2022-03-03 21:31:32 +01:00
Robin Jarry
dfb7240d48 readme: add license info
Signed-off-by: Robin Jarry <robin@jarry.cc>
2022-02-06 16:37:05 +01:00
Robin Jarry
bf74e7acb1 readme: remove #aerc-devel irc channel
This channel has not received much activity and all development
discussions are happening on #aerc. No need to multiply channels.

Signed-off-by: Robin Jarry <robin@jarry.cc>
2022-02-06 16:37:05 +01:00
Mark Dain
fc07495ee8 readme: add shield for github macos build 2022-01-28 20:52:49 +01:00
inwit
50b0436510 readme: fix typo in contribution guide
git: 'sendemail' is not a git command. See 'git --help'.

The most similar command is
        send-email

Fixes: b84374a572 ("readme: add contribution guide")
Signed-off-by: inwit <inwit@sindominio.net>
2022-01-24 09:48:22 +01:00
Robin Jarry
662a82e7db readme: add package links to debian and fedora
Signed-off-by: Robin Jarry <robin@jarry.cc>
2022-01-20 20:52:11 +01:00
Robin Jarry
b84374a572 readme: add contribution guide
This has been requested numerous times. People are not all used to the
git email workflow. Also, I am quite anal about commit messages.

Signed-off-by: Robin Jarry <robin@jarry.cc>
2021-12-11 21:45:38 +01:00
Robin Jarry
36c9840f9b readme: update with fork info
Signed-off-by: Robin Jarry <robin@jarry.cc>
2021-10-30 22:07:32 +02:00
Noam Preil
d39c6b449e README: freenode -> libera.chat 2021-08-26 09:18:56 +02:00
y0ast
889d89b42e Freshen up readme with binary packages 2020-12-27 10:02:47 +01:00
Gabriel Augendre
1790b1e7f0 Format config path in README 2020-07-05 12:24:39 +02:00
Reto Brunner
8c023cdb38 Readme: add config location of MacOS 2020-04-12 15:53:44 +02:00
Reto Brunner
2b53347d0d README: include demo and update required go version 2020-04-07 14:50:13 -04:00
Noah Kleiner
77d54fe99f Add link to scdoc 2020-02-02 11:10:38 +01:00
Reto Brunner
0016775278 Add notmuch docs 2019-08-08 10:11:20 +09:00
Drew DeVault
9bf1a0418b Update README.md 2019-07-14 13:53:09 -04:00
Lyle Hanson
0b14d92baf Document collecting log output
Redirecting stdout writes log output to that file, but this wasn't
easily discoverable.

v2 removes changes to aerc-tutorial; I was also on the fence about that,
and agree that it isn't on-topic for the tutorial.

Addresses https://todo.sr.ht/~sircmpwn/aerc2/180
2019-06-14 10:55:55 -04:00
Drew DeVault
df1209b60e Update docs per filters rewrite 2019-06-07 11:56:48 -04:00
Drew DeVault
19646823c9 Clarify socksify dependency 2019-06-04 09:42:10 -04:00
Drew DeVault
ba41b98e3d Update README.md with better dependency list 2019-06-04 08:13:50 -04:00
Drew DeVault
855362d813 Update to the latest go-libvterm 2019-05-26 15:13:37 -04:00
Drew DeVault
ee61c28e75 Add aerc-announce to README.md 2019-05-26 12:00:51 -04:00
Drew DeVault
4a4f7115f0 Update README.md 2019-05-25 16:00:19 -04:00
Drew DeVault
a6012f2292 Update README.md 2019-05-25 15:58:40 -04:00
Drew DeVault
7880bd9374 Update README.md 2019-05-25 15:55:50 -04:00
Drew DeVault
9c10a90cac Document dependencies 2019-05-17 18:15:50 -04:00
Drew DeVault
fc719e47c4 Add man pages 2019-05-17 13:46:26 -04:00
Drew DeVault
9b2612eaf2 Add IRC link to README.md 2019-05-14 14:47:46 -04:00
Drew DeVault
c05e5f73f2 Move aerc to dedicated mailing list 2019-05-11 14:31:11 -04:00
Drew DeVault
84e9853c16 Update README.md 2019-03-21 22:07:03 -04:00
Drew DeVault
b18e339a55 Add link to todo tracker 2019-03-17 17:47:35 -04:00
Drew DeVault
501c95d852 Add README.md, update license (MIT -2019) 2019-01-13 20:09:07 -05:00