From 5a48745abcf2288a32b602f4e3b645f746f8bfbc Mon Sep 17 00:00:00 2001 From: Konstantin Kharlamov Date: Thu, 5 Jun 2025 07:26:18 +0300 Subject: [PATCH 1/2] README.md: replace "purescript mode" chapter with a single sentence The chapter isn't very useful, most people know that git-forges like Github and Gitlab allow reporting issues, and the rest of the text doesn't add much value either. So replace it with a single sentence clarifying what the mode is for. --- README.md | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/README.md b/README.md index bc0ef21..f31ebed 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,7 @@ [![MELPA](https://melpa.org/packages/purescript-mode-badge.svg)](https://melpa.org/#/purescript-mode) [![Build Status](https://github.com/purescript-emacs/purescript-mode/workflows/CI/badge.svg)](https://github.com/purescript-emacs/purescript-mode/actions) -PureScript Mode for Emacs ----------------------- - -This is the PureScript mode package for Emacs. - -To report problems or suggestions, please -[open an issue](https://github.com/dysinger/purescript-mode/issues?state=open) -in the issue tracker. - -Below is a brief setup guide. +This Emacs package provides indentation, syntax highlighting, and other facilities for PureScript language. Quick Emacs rundown -------------------- From 475620d9b7d73602ab2727798da2426770d37396 Mon Sep 17 00:00:00 2001 From: Konstantin Kharlamov Date: Thu, 5 Jun 2025 07:32:27 +0300 Subject: [PATCH 2/2] README.md: remove "Quick Emacs rundown" section The mode requires somewhat involved initial setup with configuring indentation-hooks (not to mention even using Melpa requires first adding it to `package-archives'), so as it stands it doesn't really target people who doesn't even know what an init file is. That chapter of README isn't really useful IMO, let's just remove it. --- README.md | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/README.md b/README.md index f31ebed..4306d71 100644 --- a/README.md +++ b/README.md @@ -3,17 +3,6 @@ This Emacs package provides indentation, syntax highlighting, and other facilities for PureScript language. -Quick Emacs rundown --------------------- - -When Emacs is started up, it normally loads the -[Emacs initialization file](http://www.gnu.org/software/emacs/manual/html_node/emacs/Init-File.html) -usually called `~/.emacs`, `~/.emacs.el`, or `~/.emacs.d/init.el`; -with `~` standing for for your home directory. This file should -contain all of your personal customisations written as a series of -Emacs Lisp commands. In the following sections, this file will simply -be referred to as the `.emacs` file. - Installation ------------