mirror of
https://github.com/jiriks74/presence.nvim
synced 2025-05-04 16:53:00 +02:00
fix(docs): Streamline the documents
This commit is contained in:
parent
fbdd83c231
commit
cfcfc80b68
2 changed files with 43 additions and 25 deletions
|
@ -3,16 +3,17 @@
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
- [Issues](#issues)
|
- [Issues](#issues)
|
||||||
* [Bugs/Issues](#bugsissues)
|
- [Bugs/Issues](#bugsissues)
|
||||||
* [Feature Requests](#feature-requests)
|
- [Feature Requests](#feature-requests)
|
||||||
- [Pull Requests](#pull-requests)
|
- [Pull Requests](#pull-requests)
|
||||||
* [Easily use StyLua and Luacheck](#easily-use-stylua-and-luacheck)
|
- [Make sure code is up to standards](#make-sure-code-is-up-to-standards)
|
||||||
+ [Using `act`](#using-act)
|
- [Using StyLua and Luacheck directly](#using-stylua-and-luacheck-directly)
|
||||||
- [First time setup](#first-time-setup)
|
- [Using `act`](#using-act)
|
||||||
- [Using `act`](#using-act-1)
|
- [First time setup](#first-time-setup)
|
||||||
* [Luacheck Issues](#luacheck-issues)
|
- [Using `act`](#using-act)
|
||||||
* [StyLua Issues](#stylua-issues)
|
- [Luacheck Issues](#luacheck-issues)
|
||||||
|
- [StyLua Issues](#stylua-issues)
|
||||||
|
- [Assets](#assets)
|
||||||
|
|
||||||
## Issues
|
## Issues
|
||||||
|
|
||||||
|
@ -72,7 +73,25 @@ To have your PR merged more quickly you'll need to keep the following things in
|
||||||
used to. But please use Conventional commits for the PR title (and description if aplicable) for
|
used to. But please use Conventional commits for the PR title (and description if aplicable) for
|
||||||
better readability and better commit message when the PR is squashed and merged.
|
better readability and better commit message when the PR is squashed and merged.
|
||||||
|
|
||||||
### Easily use StyLua and Luacheck
|
### Make sure code is up to standards
|
||||||
|
|
||||||
|
#### Using StyLua and Luacheck directly
|
||||||
|
|
||||||
|
To run Luacheck use the following command in the repository's root directory:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
luacheck --config .luacheckrc .
|
||||||
|
```
|
||||||
|
|
||||||
|
To format using StyLua first make sure that you're using StyLua `0.20.0` (`stylua --version`)
|
||||||
|
to prevent any formatting changes between the versions. Then you can run the following command to
|
||||||
|
format the code:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
stylua .
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Using `act`
|
||||||
|
|
||||||
If you don't want to mess around with StyLua and Luacheck you can use [`act`]().
|
If you don't want to mess around with StyLua and Luacheck you can use [`act`]().
|
||||||
It's a runner for Github workflows that allows you to run them locally.
|
It's a runner for Github workflows that allows you to run them locally.
|
||||||
|
@ -83,7 +102,6 @@ it's merged.
|
||||||
If you use `nix` and `direnv` I've setup `default.nix` and `.envrc` files in the project's root
|
If you use `nix` and `direnv` I've setup `default.nix` and `.envrc` files in the project's root
|
||||||
for easy environment setup.
|
for easy environment setup.
|
||||||
|
|
||||||
#### Using `act`
|
|
||||||
|
|
||||||
##### First time setup
|
##### First time setup
|
||||||
|
|
||||||
|
@ -205,3 +223,10 @@ Look a bit above in the output to see it:
|
||||||
|
|
||||||
To fix these issues you can either manually modify the file using the diff
|
To fix these issues you can either manually modify the file using the diff
|
||||||
or you can run `stylua .` and it will apply the formatting automatically.
|
or you can run `stylua .` and it will apply the formatting automatically.
|
||||||
|
|
||||||
|
## Assets
|
||||||
|
|
||||||
|
All the assets are in the [`file_assets.lua`](lua/presence/file_assets.lua).
|
||||||
|
|
||||||
|
If you'd like to add/modify any assets create a PR to the mentioned
|
||||||
|
[`file_assets.lua`](lua/presence/file_assets.lua).
|
||||||
|
|
21
README.md
21
README.md
|
@ -137,26 +137,19 @@ OS may not yet be supported
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
- Clone the repo: `git clone https://github.com/jiriks74/presence.nvim.git`
|
- Clone the repo: `git clone https://github.com/jiriks74/presence.nvim.git`
|
||||||
- Enable [logging](#configuration) and ensure that `presence.nvim` is **_not_**
|
- Enable [logging](#configuration) and ensure that `presence.nvim` is **not**
|
||||||
in the list of vim plugins in your config
|
in the list of vim plugins in your config
|
||||||
- Run `nvim` with your local changes: `nvim --cmd
|
- Run `nvim` with your local changes: `nvim --cmd
|
||||||
'set rtp+=path/to/your/local/presence.nvim' file.txt`
|
'set rtp+=path/to/your/local/presence.nvim' file.txt`
|
||||||
- Ensure that there are no [luacheck](https://github.com/mpeterv/luacheck/)
|
- Make sure that your contribution follows
|
||||||
errors: `luacheck lua`
|
[CONTRIBUTING.md](https://github.com/jiriks74/presence.nvim/blob/main/CONTRIBUTING.md)
|
||||||
|
guidelines before creating a PR.
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
**Please use [Conventional Commits](https://www.conventionalcommits.org/)
|
**Please read [CONTRIBUTING.md](https://github.com/jiriks74/presence.nvim/blob/main/CONTRIBUTING.md)
|
||||||
if you want to contribute.
|
before creating a PR or an issue.**
|
||||||
It makes everyones jobs easier.**
|
|
||||||
|
|
||||||
**This project uses [StyLua](https://github.com/JohnnyMorganz/StyLua).
|
|
||||||
Please format your code using StyLua for better readability**
|
|
||||||
|
|
||||||
Pull requests are very welcome, feel free to open an issue to work on
|
Pull requests are very welcome, feel free to open an issue to work on
|
||||||
or message [me (@jiriks74)](https://discordapp.com/users/517810049360461837) on my
|
or [message me directly (@jiriks74)](https://discordapp.com/users/517810049360461837) on my
|
||||||
[Discord server](https://discord.gg/cCq3qcB4jB)!
|
[Discord server](https://discord.gg/cCq3qcB4jB)!
|
||||||
|
|
||||||
Asset additions and changes are also welcome! Supported file types can be found in
|
|
||||||
[`file_assets.lua`](lua/presence/file_assets.lua) and their referenced asset files
|
|
||||||
can be found in [the `icon-assets` branch](https://github.com/jiriks74/presence.nvim/tree/icon-assets).
|
|
||||||
|
|
Loading…
Reference in a new issue