Skip to content

Commit 0d67db2

Browse files
committed
Add some more details on documentation
1 parent a6433c0 commit 0d67db2

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.org

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
#+title: psci-mode
22
#+author: ardumont
33

4-
At the moment, not everything works.
5-
6-
For example, the `:r` command (which is supposed to reset the loaded modules of the current session) does nothing (but it does work in a terminal session).
4+
A major mode to try and improve the purescript repl experience within emacs.
75

86
* Description
97
** What
@@ -95,14 +93,14 @@ M-x el-get-install RET psci RET
9593

9694
*Note* Providing [[https://github.com/dimitri/el-get/pull/1973][PR]] is merged.
9795

98-
* Setup
96+
* Start and setup
9997
** Start
10098

10199
#+begin_src sh
102100
M-x psci
103101
#+end_src
104102

105-
This will open a psci repl in your project root folder (using projectile to determine that).
103+
This will open a psci repl within emacs from your current project root folder (using [[https://github.com/bbatsov/projectile][projectile]] to determine that).
106104

107105
** Setup
108106

@@ -117,18 +115,20 @@ This permits, using the same universal binding `C-c C-z`, to go back and forth b
117115

118116
* Use
119117

120-
Default bindings for this mode:
118+
Default bindings available from a purescript buffer:
121119

122120
|-------------+--------------------------------+----------------------------------------------------------------------------------------------|
123121
| Keybindings | Interactive commands | Description |
124122
|-------------+--------------------------------+----------------------------------------------------------------------------------------------|
125-
| C-c C-l | M-x psci/load-current-file! | Equivalent of `:m /path/to/current/module/file.purs` |
126-
| C-c M-n | M-x psci/load-module! | Equivalent of `:i your.current.module.name` |
127-
| C-c C-r | M-x psci/load-project-modules! | Load or reload modules defined in your project file .psci |
128-
| N/A | M-x psci/reset! | Equivalent of `:r` |
123+
| C-c C-l | M-x psci/load-current-file! | Equivalent of `:m /path/to/current/module/file.purs` - Load <file> for importing |
124+
| C-c M-n | M-x psci/load-module! | Equivalent of `:i your.current.module.name` - Import <module> for use in PSCI |
125+
| C-c C-r | M-x psci/load-project-modules! | Load or reload files defined in the project file .psci |
126+
| N/A | M-x psci/reset! | Equivalent of `:r` - Reset |
129127
| C-c C-z | | Provided you use the previous setup, this will switch back and forth between repl and buffer |
130128
|-------------+--------------------------------+----------------------------------------------------------------------------------------------|
131129

130+
131+
132132
* Runtime dependencies
133133

134134
A purescript dev platform ready.

0 commit comments

Comments
 (0)