From 13481c3755c18b52aaad5d18f516943448dace65 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Billy=20=E3=83=93=E3=83=AA=E3=82=A2=E3=83=A0?= Date: Thu, 4 Jan 2024 22:42:28 +0800 Subject: [PATCH] docs: update feature list, links --- README.md | 47 +++++++++++++++++++++++++++++++++-------------- 1 file changed, 33 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 65fe5451..8f261d49 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@


- + Project License @@ -13,11 +13,15 @@ Features • Developer Docs • Code of Conduct • + Downloads • Marketplace

-
+

-Biscuit is a lightweight, easy to use code editor for any language. We wrote it in python, using only tkinter for GUI. It's a great alternative to [insert funny thing here]! Scroll down to see [some of the features](https://github.com/billyeatcookies/Biscuit/tree/main?tab=readme-ov-file#features). +Biscuit is a lightweight, awesome code editor for any language. Biscuit supports essential language features such as Smart Code Completions, Syntax highlighting, etc. We wrote it in python, using only tkinter for GUI. It's a great alternative to [insert funny thing here]! Scroll down to see [some of the features](https://github.com/billyeatcookies/Biscuit/tree/main?tab=readme-ov-file#features). + +- Explore all community made extensions & authors at [Biscuit Extensions Marketplace](https://billyeatcookies.github.io/biscuit-extensions/) +- For developer/user guides or API reference, read the [documentation](https://billyeatcookies.github.io/biscuit). ## Installing - Download latest **stable builds** from [**releases page**](https://github.com/billyeatcookies/Biscuit/releases). @@ -28,34 +32,49 @@ To compile Biscuit for your platform, see [compiling guide](https://github.com/b ## Contributing Your contributions are greatly appreciated! please have a look at our [**developer docs**](https://github.com/billyeatcookies/Biscuit/blob/main/CONTRIBUTING.md) for an outline of the project and to setup the environment. -For feature suggestions and bug reports, please check [**issue tracker**](https://github.com/billyeatcookies/Biscuit/issues). - +- For feature suggestions and bug reports, please check [issue tracker](https://github.com/billyeatcookies/Biscuit/issues) +- Community made Extensions can be published at: [**Biscuit Extensions Repository**](https://github.com/billyeatcookies/biscuit-extensions) + ## Features +## Smart Auto-completions +When the opened file have a recognized and supported file type, and also have language extensions installed, the autocomplete widget will automatically turn on LSP mode, the completions will be handled by registered language server afterwards. LSP mode enables smart and context sensitive code suggestions, as demonstrated below. +When there are no language extensions available/installed, autocomplete widget goes to word mode, the completions will not be context sensitive and can be unexpected. + +![Autocompletions](https://github.com/billyeatcookies/biscuit/assets/70792552/885ebf36-ce18-45a3-ae57-9a4b709331f7) + +## Hover for Documentation +Identifiers when hovered pops up a floating window on top, containing the documentation (if there is) of that symbol. + +![hover](https://github.com/billyeatcookies/biscuit/assets/70792552/4f0ba532-4ec0-49c3-ad08-19e8a622a416) -**Git Support** +## Goto Definitions by `ctrl` + clicking on symbols +User can jump directly into symbol definitions by `ctrl` + clicking on them, the definition containing script will open up in new/existing tab. If there are multiple definitions, window containing all the definitions will popup right below the symbol to pick from + +![gotodef](https://github.com/billyeatcookies/biscuit/assets/70792552/fb3a012f-1e93-4c00-930c-843a9728b958) + +## **Git Support** ![image](https://github.com/billyeatcookies/Biscuit/assets/70792552/ea231a77-7899-4560-ab97-95828bb96932) -**Integrated Terminals, Extension center** +## **Integrated Terminals, Extension center** ![image](https://github.com/billyeatcookies/Biscuit/assets/70792552/2531ea77-a1e0-4a81-96c9-66ad6b6b0c6d) -**A Damn Split-Pane Markdown Editor** +## **Split-Pane Markdown Editor** ![image](https://github.com/billyeatcookies/Biscuit/assets/70792552/2e58ff22-2412-4cb1-b183-673591200308) -**Command Palette for Quick Access** +## **Command Palette for Quick Access** ![ezgif com-video-to-gif](https://github.com/billyeatcookies/Biscuit/assets/70792552/e0868336-a15f-4b98-a62e-a822e2211e57) -**Syntax Highlighting & Autocompletions** - -![completion](https://github.com/billyeatcookies/Biscuit/assets/70792552/08fe5cbf-81d7-4770-8a80-d70821bf96c9) - -**PathView for the Breadcrumbs!** +## **PathView for the Breadcrumbs!** ![pathview](https://imgur.com/CztWtni.jpg) + +# License +Biscuit uses the MIT License, please check [LICENSE](https://github.com/billyeatcookies/Biscuit/blob/main/LICENSE.md).