mirror of
https://github.com/alrayyes/st
synced 2023-11-14 15:56:30 +00:00
Update and rename README.md to README.org
This commit is contained in:
parent
bf6924eec4
commit
17efd70d09
38
README.md
38
README.md
@ -1,38 +0,0 @@
|
||||
# My Suckless Terminal Build
|
||||
|
||||
[Suckless Terminal](https://st.suckless.org) [Arch](https://www.archlinux.org/) package with a few patches installed to keep things nice:
|
||||
|
||||
+ [alpha](https://st.suckless.org/patches/alpha/)
|
||||
+ [clipboard](https://st.suckless.org/patches/clipboard/)
|
||||
+ [solarized](https://st.suckless.org/patches/solarized/)
|
||||
+ [vertcenter](https://st.suckless.org/patches/vertcenter/)
|
||||
+ [scrollback](https://st.suckless.org/patches/scrollback/)
|
||||
+ [scrollback-mouse](https://st.suckless.org/patches/scrollback/)
|
||||
+ [disable_bold_italic_fonts](https://st.suckless.org/patches/disable_bold_italic_fonts/)
|
||||
|
||||
## Terminal-specific mappings
|
||||
|
||||
+ Scroll through history -- Shift+PageUp/PageDown or Shift+Mouse wheel
|
||||
+ Alt-k and Alt-j scroll back/foward in history one line at a time
|
||||
+ Alt-u and Alt-d scroll back/foward in history a page at a time
|
||||
+ Increase/decrease font size -- Shift+Alt+PageUp/PageDown
|
||||
+ Return to default font size -- Shift+Alt+Home
|
||||
+ Paste -- Shift+Insert
|
||||
|
||||
## Installation
|
||||
|
||||
```
|
||||
makepkg -si
|
||||
```
|
||||
|
||||
## Further Notes
|
||||
|
||||
+ Change the transparency value by modifying the `alpha` variable in [config.h](https://github.com/alrayyes/st/blob/master/config.h).
|
||||
+ Default font is [Fira Code Nerd Font Mono](https://github.com/ryanoasis/nerd-fonts/blob/master/patched-fonts/FiraCode)
|
||||
* When modifying [config.h](https://github.com/alrayyes/st/blob/master/config.h) be sure to run ```updpkgsums``` to update checksums before running ```makepkg -si```
|
||||
|
||||
## License
|
||||
|
||||
This theme is released under the MIT License. For more information read the [license][license].
|
||||
|
||||
[license]: https://github.com/alrayyes/st/blob/master/LICENSE.md
|
61
README.org
Normal file
61
README.org
Normal file
@ -0,0 +1,61 @@
|
||||
* My Suckless Terminal Build
|
||||
:PROPERTIES:
|
||||
:CUSTOM_ID: my-suckless-terminal-build
|
||||
:END:
|
||||
|
||||
[[https://st.suckless.org][Suckless Terminal]]
|
||||
[[https://www.archlinux.org/][Arch]] package with a few patches
|
||||
installed to keep things nice:
|
||||
|
||||
- [[https://st.suckless.org/patches/alpha/][alpha]]
|
||||
- [[https://st.suckless.org/patches/clipboard/][clipboard]]
|
||||
- [[https://st.suckless.org/patches/solarized/][solarized]]
|
||||
- [[https://st.suckless.org/patches/vertcenter/][vertcenter]]
|
||||
- [[https://st.suckless.org/patches/scrollback/][scrollback]]
|
||||
- [[https://st.suckless.org/patches/scrollback/][scrollback-mouse]]
|
||||
- [[https://st.suckless.org/patches/disable_bold_italic_fonts/][disable_bold_italic_fonts]]
|
||||
|
||||
** Terminal-specific mappings
|
||||
:PROPERTIES:
|
||||
:CUSTOM_ID: terminal-specific-mappings
|
||||
:END:
|
||||
|
||||
- Scroll through history -- Shift+PageUp/PageDown or Shift+Mouse wheel
|
||||
- Alt-k and Alt-j scroll back/foward in history one line at a time
|
||||
- Alt-u and Alt-d scroll back/foward in history a page at a time
|
||||
- Increase/decrease font size -- Shift+Alt+PageUp/PageDown
|
||||
- Return to default font size -- Shift+Alt+Home
|
||||
- Paste -- Shift+Insert
|
||||
|
||||
** Installation
|
||||
:PROPERTIES:
|
||||
:CUSTOM_ID: installation
|
||||
:END:
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
makepkg -si
|
||||
#+END_EXAMPLE
|
||||
|
||||
** Further Notes
|
||||
:PROPERTIES:
|
||||
:CUSTOM_ID: further-notes
|
||||
:END:
|
||||
|
||||
- Change the transparency value by modifying the =alpha= variable in
|
||||
[[https://github.com/alrayyes/st/blob/master/config.h][config.h]].
|
||||
- Default font is
|
||||
[[https://github.com/ryanoasis/nerd-fonts/blob/master/patched-fonts/FiraCode][Fira
|
||||
Code Nerd Font Mono]]
|
||||
- When modifying
|
||||
[[https://github.com/alrayyes/st/blob/master/config.h][config.h]] be
|
||||
sure to run =updpkgsums= to update checksums before running
|
||||
=makepkg -si=
|
||||
|
||||
** License
|
||||
:PROPERTIES:
|
||||
:CUSTOM_ID: license
|
||||
:END:
|
||||
|
||||
This theme is released under the MIT License. For more information read
|
||||
the [[file:LICENSE][license]].
|
||||
|
Loading…
Reference in New Issue
Block a user