Merge remote-tracking branch 'refs/remotes/origin/main'

Author: Zeioth

README.md

@@ -11,16 +11,20 @@ Neovim compiler for building and running your code without having to configure a
 
 ## Table of contents
 
+- [Why](#why)
 - [Supported languages](#supported-languages)
 - [Required system dependencies](#required-system-dependencies)
 - [How to install](#how-to-install)
-- [Available commands](#available-commands)
+- [Commands](#commands)
 - [Basic usage](#how-to-use-basic-usage)
-- [How to create a solution (advanced)](#how-to-create-a-solution-advanced)
-- [Make (advanced)](#make-advanced)
+- [Creating a solution (optional)](#creating-a-solution-optional)
+- [Make](#make)
 - [Quick start](#quick-start)
 - [FAQ](#faq)
 
+## Why
+Those familiar with Visual Studio IDE will remember how convenient it was to just press a button and having your program compiled. I wanted to bring that same user experience to NeoVim.
+
 ## Supported languages
 
 * [c](https://github.com/Zeioth/compiler.nvim/blob/main/lua/compiler/languages/c.lua)
@@ -56,33 +60,28 @@ Pull requests are welcome. See [FAQ](#faq).
 * cobol
 
 ## Required system dependencies
-Some languages require you manually install their compilers in your machine, so compiler.nvim is able to call them. Please [check here](https://github.com/Zeioth/Compiler.nvim/wiki/how-to-install-the-required-dependencies), as the packages will be different depending your operative system.
+Some languages require you manually install their compilers in your machine, so compiler.nvim is able to call them. [Please check here](https://github.com/Zeioth/Compiler.nvim/wiki/how-to-install-the-required-dependencies), as the packages will be different depending your operative system.
 
 ## How to install
 lazy.nvim package manager
 ```lua
 { -- This plugin
   "Zeioth/compiler.nvim",
-  cmd = {"CompilerOpen", "CompilerToggleResults"},
+  cmd = {"CompilerOpen", "CompilerToggleResults", "CompilerRedo"},
   dependencies = { "stevearc/overseer.nvim" },
   config = function(_, opts) require("compiler").setup(opts) end,
 },
-{ -- The framework we use to run tasks
+{ -- The task runner we use
   "stevearc/overseer.nvim",
-  commit = "3047ede61cc1308069ad1184c0d447ebee92d749", -- Recommended to to avoid breaking changes
-  cmd = {"CompilerOpen", "CompilerToggleResults"},
+  commit = "3047ede61cc1308069ad1184c0d447ebee92d749",
+  cmd = { "CompilerOpen", "CompilerToggleResults" },
   opts = {
-    -- Tasks are disposed 5 minutes after running to free resources.
-    -- If you need to close a task inmediatelly:
-    -- press ENTER in the menu you see after compiling on the task you want to close.
     task_list = {
       direction = "bottom",
       min_height = 25,
       max_height = 25,
       default_detail = 1,
-      bindings = {
-        ["q"] = function() vim.cmd("OverseerClose") end ,
-      },
+      bindings = { ["q"] = function() vim.cmd("OverseerClose") end },
     },
   },
 },
@@ -98,7 +97,7 @@ vim.api.nvim_buf_set_keymap(0, 'n', '<F6>', "<cmd>CompilerOpen<cr>", { noremap =
 vim.api.nvim_buf_set_keymap(0, 'n', '<S-F6>', "<cmd>CompilerToggleResults<cr>", { noremap = true, silent = true })
 ```
 
-## Available commands
+## Commands
 
 | Command | Description|
 |--|--|
@@ -110,7 +109,7 @@ vim.api.nvim_buf_set_keymap(0, 'n', '<S-F6>', "<cmd>CompilerToggleResults<cr>",
 ## How to use (Basic usage)
 This is what hapen when you select `build & run`, `build`, or `run` in the compiler:
 
-> compiler.nvim will look for the conventional entry point file for the current lenguage you are using. To achieve this, it searches in your current working directory for the next files
+> compiler.nvim will look for the conventional entry point file for the current language you are using. To achieve this, it searches in your current working directory for the next files
 
 | Language | Default entry point | Default output |
 |--|--|--|
@@ -132,7 +131,7 @@ This is how the compilation results look after selecting `Build & run program` i
 ![screenshot_2023-06-19_13-59-37_766847673](https://github.com/Zeioth/compiler.nvim/assets/3357792/42c4ec0d-4446-4ac6-9c4a-478a32d23ca7)
 [For more info see wiki - when to use every option](https://github.com/Zeioth/compiler.nvim/wiki/When-to-use-every-option)
 
-## How to create a solution (Advanced)
+## Creating a solution (optional)
 If you want to have more control, you can create a `.solution` file in your working directory by using this template:
 
 ```
@@ -149,7 +148,7 @@ Where every [entry] represents a program to compile
 
 | option | Description |
 |--|--|
-| [entry] | Anything inside the brackets will be ignored. Write anything you want inside. You can use it to easily identify your program.  |
+| [entry] | Anything inside the brackets will be ignored. Write anything you want to easily identify your program.  |
 | entry_point | Path of the file containing the entry point of the program.  | 
 | output | Path where the compiled program will be written. | 
 | parameters | Are optional parameters to pass to the compiler. If you don't need them you can delete this option or leave it as empty string if you want. | 
@@ -163,13 +162,11 @@ Where every [entry] represents a program to compile
 
 Please, respect the syntax of the `.solution` file, as we intentionally do not parse errors in order to keep the compiler code simple. [For more examples see wiki](https://github.com/Zeioth/Compiler.nvim/wiki/solution-examples).
 
-## Make (Advanced)
-This option will look for a Makefile in the working directory and execute it with `make Makefile`. If your Makefile is not in the working directory, you can either change your current working directory, or create a symbolic link to the Makefile (and if you do, add it to .gitignore).
-
-For building systems not directly supported by Compiler.nvim: Create a Makefile and use it to call cmake, maven, or any other build system you want to use from there. [For more examples see wiki](https://github.com/Zeioth/Compiler.nvim/wiki/Makefile-examples).
+## Make
+This option will look for a `Makefile` in the working directory and execute it with `make Makefile`. [For more examples see wiki](https://github.com/Zeioth/Compiler.nvim/wiki/Makefile-examples).
 
 ## Quick start
-Starting to use [Compiler.nvim](https://github.com/Zeioth/compiler.nvim) is very easy. Create `./c_example/main.c` and paste this code. Then do `:cd ./c_example/` to change the working directory to the project.
+Create `./c_example/main.c` and paste this code. Then do `:cd ./c_example/` to change the working directory to the project.
 
 ```c
 #include <stdio.h>
@@ -180,7 +177,7 @@ int main() {
 }
 ```
 
-All you have to do now is to open the compiler and select `Build and run`. You will see the results.
+Open the compiler and select `Build and run`. You will see the compilation results.
 
 ![screenshot_2023-07-25_23-56-57_069109256](https://github.com/Zeioth/compiler.nvim/assets/3357792/fd102350-ca44-4501-9cb0-db2ea0093264)
 
@@ -189,13 +186,15 @@ All you have to do now is to open the compiler and select `Build and run`. You w
 * **How can I add a language that is not supported yet?** Fork the project, and go to the directory `/compiler/languages`. Copy `c.lua` and rename it to any language you would like to add, for example `ruby.lua`. Now modify the file the way you want. It is important you name the file as the filetype of the language you are implementing. Then please, submit a PR to this repo so everyone can benefit from it.
 * **How can I change the way the compiler works?** Same as the previous one.
 * **Is this plugin just a compiler, or can I run scripts too?** Yes you can. But if your script receive parameters, we recommend you to use the terminal instead, because creating a `.solution` file just to be able to pass parameters to your simple shell script is probably a overkill, and not the right tool.
+* **Is this plugin also a building system manager?** No, it is not. For convenience, we provide the option `Run Makefile`, which should cover some cases of use. But if your workflow relies heavily on building systems, please consider installing an specific neovim plugin for this porpuse. [See wiki](https://github.com/Zeioth/Compiler.nvim/wiki/Makefile-examples#building-systems-support).
 * **I'm a windows user, do I need to do something special?** In theory no. Check the [dependencies section of this README.md](https://github.com/Zeioth/Compiler.nvim/wiki/how-to-install-the-required-dependencies) and make sure you have them. If for some wild reason a required dependency don't exist on windows, or you don't know how to get it, the easy way is to enable the Windows Linux Subsystem and run neovim from there. Then you can just `sudo apt install some_package` for anything you may need.
 * **Where are the global options?** There are not. Creating a `.solution` file of your project is the way to configure stuff. This way we can keep the code extra simple.
 *  **How can I disable notifications when compiling?** Check [here](https://github.com/stevearc/overseer.nvim/issues/158#issuecomment-1631542247).
 * **I'm coding a web, how do I run it?** Please don't try to compile/run web languages. I recommend you this strategy instead:
 
   * A way to transpile: toggleterm + tmux.
   * A way run the project: Just keep the website opened in your browser.
+* **How can I auto `:cd` my projects?** Use [this fork](https://github.com/Zeioth/project.nvim) of the plugin `project.nvim`.
 
 ## 🌟 Support the project
 If you want to help me, please star this repository to increase the visibility of the project.
@@ -210,7 +209,6 @@ If you want to help me, please star this repository to increase the visibility o
 </a>
 
 ## Roadmap
-* Make compiler.nvim 100% async (WIP: proof of concept ready on C, migrating other languages).
-* Make tests 100% async, so we can test faster and more reliably.
-* Research the viability of supporting building system for languages which have an standard (c, cpp, rust, java) directly without a Makefile.
 
+* Better windows compatibility when not using WLS: The commands `rm -rf` and `mkdir -p` only exist on unix. To support Windows without WLS we should run the equivalent powershell command when Windows is detected.
+* `C`, `C++`, `C#`: Consider adding the new options `build solution (dotnet)`, `build solution and run (dotnet)`, and `run solution (dotnet)`. Most people will prefer using their visual studio project file when available. → Since the dotnet command is the same for all languages, we just need to implement this once.