-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
31e38f9
commit dcb2135
Showing
10 changed files
with
1,423 additions
and
1,423 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,10 @@ | ||
| /.vscode | ||
| /target | ||
| /test | ||
| /test2 | ||
| /test3 | ||
| /name.md | ||
| /brr.log | ||
| /brr.conf | ||
| /frankenstein.txt | ||
| /shakespeare.txt | ||
| /.vscode | ||
| /target | ||
| /test | ||
| /test2 | ||
| /test3 | ||
| /name.md | ||
| /brr.log | ||
| /brr.conf | ||
| /frankenstein.txt | ||
| /shakespeare.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,21 @@ | ||
| [package] | ||
| name = "brr" | ||
| version = "1.0.0" | ||
| edition = "2021" | ||
| description = "the perfunctory prose proliferator" | ||
| homepage = "https://github.com/letterlock/brr" | ||
| repository = "https://github.com/letterlock/brr" | ||
| keywords = ["tui", "text-editor"] | ||
| readme = "README.md" | ||
| license = "GPL-3.0-or-later" | ||
|
|
||
|
|
||
| [dependencies] | ||
| crossterm = "0.27.0" | ||
| unicode-segmentation = "1.10.1" | ||
| words-count = "0.1.6" | ||
| log = "0.4.20" | ||
| simple-logging = "2.0.2" | ||
|
|
||
| [build-dependencies] | ||
| winres = "0.1" | ||
| [package] | ||
| name = "brr" | ||
| version = "1.0.0" | ||
| edition = "2021" | ||
| description = "the perfunctory prose proliferator" | ||
| homepage = "https://github.com/letterlock/brr" | ||
| repository = "https://github.com/letterlock/brr" | ||
| keywords = ["tui", "text-editor"] | ||
| readme = "README.md" | ||
| license = "GPL-3.0-or-later" | ||
|
|
||
|
|
||
| [dependencies] | ||
| crossterm = "0.27.0" | ||
| unicode-segmentation = "1.10.1" | ||
| words-count = "0.1.6" | ||
| log = "0.4.20" | ||
| simple-logging = "2.0.2" | ||
|
|
||
| [build-dependencies] | ||
| winres = "0.1" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,59 +1,59 @@ | ||
| # brr | ||
|
|
||
| <p align="center"> | ||
| <img src="assets/brr.png" width="15%"> | ||
| </p> | ||
|
|
||
| ## the perfunctory prose proliferator | ||
| > original programmery provided by the passionately proficient progenitors of [kilo](https://github.com/antirez/kilo) and [hecto](https://github.com/pflenker/hecto-tutorial). | ||
| > amateurishly adapted and apprehensively altered by maxwell letterlock. | ||
| brr is a text editor that adapts some of the permanency of writing by hand or on a typewriter in order to allow the user to produce text with as few edits as necessary, hopefully curbing the urge to constantly edit whatever they have written down. | ||
|
|
||
| for this reason, it consists of an (intentionally) minimal main set of "features": | ||
| - brr cannot edit saved files except to add to them | ||
| - once you start writing, brr will save every few words (six by default) | ||
| - after a period of inactivity, (five seconds by default) brr will save the file upon the next keypress | ||
|
|
||
| it was my first ever project and i never finished its original c-based incarnation. eventually, i decided i would do the easy and straightforward thing and port it to rust. :^) | ||
|
|
||
| brr was originally adapted from [this](https://viewsourcecode.org/snaptoken/kilo/01.setup.html) tutorial, and later ported with the help of [this](https://www.flenker.blog/hecto/) one. i also took a lot of inspiration from the way [kibi](https://github.com/ilai-deutel/kibi) does things, it's a very cool project that is a very faithful implimentation of the original kilo project in rust. the code is extremely well documented and flexible, and it does some very clever things to achieve such a tiny codebase. | ||
|
|
||
| i still have no clue what i'm doing, my code is very inefficient and probably downright stupid in some places, but everything seems to be working! if you do find a bug, fix something or tidy something up, feel free to submit an issue or a pull request. if you do fix or tidy something, i would very much appreciate it if you would explain how and why, so i can learn! | ||
|
|
||
| finally, just to be clear: **you should back up any really important documents before editing them with brr.** i've done all i can to make sure nothing happens, and i'll be using brr myself, so i have an interest in making it not delete things i care about, but i'm a novice amateur programmer *at best*. as with any time you're trusting a file you care about to a stranger's program -- be careful! | ||
|
|
||
| ## more features | ||
| - editing *and* viewing mode -- you can scroll back through your file! (wow!) | ||
| - a slightly inaccurate word count -- you can kind of see how much you've written when you're done! (incredible!) | ||
| - soft word wrapping! don't look at the code for this! (unprecedented!) | ||
| - ability to open a different file without leaving the program! (revolutionary!) | ||
| - a config file! (extraordinary!) | ||
| - editable text is highlighted! (inconceivable!) | ||
|
|
||
| ## installation | ||
| the easiest way to install brr is to just download the executable file, put it where you want, and run it. packaging and distributing brr through any kind of package system is a bit beyond my current expertise (and will to learn), so i'll leave it with simple binaries for now. | ||
|
|
||
| #### virus problems | ||
| i've had issues with the windows binary being flagged by antivirus software, which is apparently a common issue. i'm not sure what to do about that, the only thing i've heard that maybe helps is signing it, but i don't have the means for that. i've scanned it myself and with [virustotal](https://www.virustotal.com/gui/file/ab1f1775cae053f2bcef9fb43385cd51e398f8425b307df0d29819983c58864b?nocache=1). | ||
| if you're nervous about it, that's probably good! it's smart not to trust some random .exe from the internet. you can peruse the source code for anything malicious if you know how, and if you don't know how but still trust my code, you can check out the below instructions to compile it from source. doing things that way will avoid you having to trust that i'm not injecting some malicious code before uploading it. | ||
|
|
||
| #### compiling from source | ||
| if you want to compile from source, the easiest way is to use the native rust package manager cargo. you can install cargo with [this guide](https://doc.rust-lang.org/stable/cargo/getting-started/installation.html). | ||
| after you have cargo (and therefore the rust compiler), you can just run the following in a terminal: | ||
| ``` | ||
| $ cargo install brr | ||
| ``` | ||
| to install. | ||
|
|
||
| ## usage | ||
| brr can be called from the terminal or run from its executable. if you run it directly, you will reach a prompt asking you to type in the name of the file you want to open. | ||
| regardless of how you start the application, this file name can be a path to the file or just the name of a file in the same folder as brr. by default, if you type in a file name and forget to add ".txt" or ".md" on the end of it, brr will search for a file with one of those extensions in the folder you're working within and load that instead. this feature can be turned off in the config file. | ||
| if you add brr to your path, you can of course call it from anywhere like a typical linux terminal text editor. | ||
|
|
||
| once you're editing a file, you'll see the text you can actually affect appears highlighted, while the saved text appears normal. your cursor will be in the middle of the terminal window, and the text will scroll instead of the cursor, similar to a typewriter. | ||
|
|
||
| if you want to take a break from writing and look over what you've written, you can press "ctrl+e" to change to view mode, or "ctrl+h" for helpful keybinds. "ctrl+s" saves and "ctrl+o" will allow you to open a new file in the same way as above. | ||
|
|
||
| ### configuration | ||
| brr uses a simple plaintext config file that should be fairly straightforward to use, just open it in your favourite (actually functional) text editor and change the values after the equals symbols! the 'brr.conf.default' file contains all the default values and syntax, as well as some explanations for the various options. | ||
| # brr | ||
|
|
||
| <p align="center"> | ||
| <img src="assets/brr.png" width="15%"> | ||
| </p> | ||
|
|
||
| ## the perfunctory prose proliferator | ||
| > original programmery provided by the passionately proficient progenitors of [kilo](https://github.com/antirez/kilo) and [hecto](https://github.com/pflenker/hecto-tutorial). | ||
| > amateurishly adapted and apprehensively altered by maxwell letterlock. | ||
| brr is a text editor that adapts some of the permanency of writing by hand or on a typewriter in order to allow the user to produce text with as few edits as necessary, hopefully curbing the urge to constantly edit whatever they have written down. | ||
|
|
||
| for this reason, it consists of an (intentionally) minimal main set of "features": | ||
| - brr cannot edit saved files except to add to them | ||
| - once you start writing, brr will save every few words (six by default) | ||
| - after a period of inactivity, (five seconds by default) brr will save the file upon the next keypress | ||
|
|
||
| it was my first ever project and i never finished its original c-based incarnation. eventually, i decided i would do the easy and straightforward thing and port it to rust. :^) | ||
|
|
||
| brr was originally adapted from [this](https://viewsourcecode.org/snaptoken/kilo/01.setup.html) tutorial, and later ported with the help of [this](https://www.flenker.blog/hecto/) one. i also took a lot of inspiration from the way [kibi](https://github.com/ilai-deutel/kibi) does things, it's a very cool project that is a very faithful implimentation of the original kilo project in rust. the code is extremely well documented and flexible, and it does some very clever things to achieve such a tiny codebase. | ||
|
|
||
| i still have no clue what i'm doing, my code is very inefficient and probably downright stupid in some places, but everything seems to be working! if you do find a bug, fix something or tidy something up, feel free to submit an issue or a pull request. if you do fix or tidy something, i would very much appreciate it if you would explain how and why, so i can learn! | ||
|
|
||
| finally, just to be clear: **you should back up any really important documents before editing them with brr.** i've done all i can to make sure nothing happens, and i'll be using brr myself, so i have an interest in making it not delete things i care about, but i'm a novice amateur programmer *at best*. as with any time you're trusting a file you care about to a stranger's program -- be careful! | ||
|
|
||
| ## more features | ||
| - editing *and* viewing mode -- you can scroll back through your file! (wow!) | ||
| - a slightly inaccurate word count -- you can kind of see how much you've written when you're done! (incredible!) | ||
| - soft word wrapping! don't look at the code for this! (unprecedented!) | ||
| - ability to open a different file without leaving the program! (revolutionary!) | ||
| - a config file! (extraordinary!) | ||
| - editable text is highlighted! (inconceivable!) | ||
|
|
||
| ## installation | ||
| the easiest way to install brr is to just download the executable file, put it where you want, and run it. packaging and distributing brr through any kind of package system is a bit beyond my current expertise (and will to learn), so i'll leave it with simple binaries for now. | ||
|
|
||
| #### virus problems | ||
| i've had issues with the windows binary being flagged by antivirus software, which is apparently a common issue. i'm not sure what to do about that, the only thing i've heard that maybe helps is signing it, but i don't have the means for that. i've scanned it myself and with [virustotal](https://www.virustotal.com/gui/file/ab1f1775cae053f2bcef9fb43385cd51e398f8425b307df0d29819983c58864b?nocache=1). | ||
| if you're nervous about it, that's probably good! it's smart not to trust some random .exe from the internet. you can peruse the source code for anything malicious if you know how, and if you don't know how but still trust my code, you can check out the below instructions to compile it from source. doing things that way will avoid you having to trust that i'm not injecting some malicious code before uploading it. | ||
|
|
||
| #### compiling from source | ||
| if you want to compile from source, the easiest way is to use the native rust package manager cargo. you can install cargo with [this guide](https://doc.rust-lang.org/stable/cargo/getting-started/installation.html). | ||
| after you have cargo (and therefore the rust compiler), you can just run the following in a terminal: | ||
| ``` | ||
| $ cargo install brr | ||
| ``` | ||
| to install. | ||
|
|
||
| ## usage | ||
| brr can be called from the terminal or run from its executable. if you run it directly, you will reach a prompt asking you to type in the name of the file you want to open. | ||
| regardless of how you start the application, this file name can be a path to the file or just the name of a file in the same folder as brr. by default, if you type in a file name and forget to add ".txt" or ".md" on the end of it, brr will search for a file with one of those extensions in the folder you're working within and load that instead. this feature can be turned off in the config file. | ||
| if you add brr to your path, you can of course call it from anywhere like a typical linux terminal text editor. | ||
|
|
||
| once you're editing a file, you'll see the text you can actually affect appears highlighted, while the saved text appears normal. your cursor will be in the middle of the terminal window, and the text will scroll instead of the cursor, similar to a typewriter. | ||
|
|
||
| if you want to take a break from writing and look over what you've written, you can press "ctrl+e" to change to view mode, or "ctrl+h" for helpful keybinds. "ctrl+s" saves and "ctrl+o" will allow you to open a new file in the same way as above. | ||
|
|
||
| ### configuration | ||
| brr uses a simple plaintext config file that should be fairly straightforward to use, just open it in your favourite (actually functional) text editor and change the values after the equals symbols! the 'brr.conf.default' file contains all the default values and syntax, as well as some explanations for the various options. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,86 +1,86 @@ | ||
| # brr config file | ||
| # this is the default config file for brr, you can | ||
| # copy it and change it to your liking, just make | ||
| # sure it's called brr.conf and in the same folder | ||
| # as brr's executable. | ||
|
|
||
| # start-edit | ||
| # defines if brr should start in edit mode. false | ||
| # starts brr in view mode. | ||
| # options: true, false | ||
| # default: start-edit = true | ||
| start-edit = true | ||
|
|
||
| # open-search | ||
| # when this is active and you open a file without | ||
| # an extension at the end, brr will automatically | ||
| # search the current working directory for a file | ||
| # matching that name in either .txt or .md format | ||
| # and open that instead. | ||
| # options: true, false | ||
| # default: open-search = true | ||
| open-search = true | ||
|
|
||
| # quit-word-count | ||
| # when this is active, brr will give you an | ||
| # approximate count of how many words and | ||
| # characters you wrote during the session. | ||
| # note: if you open a new file without closing | ||
| # brr, the count will only show data from the | ||
| # last file you edited. | ||
| # options: true, false | ||
| # default: count-on-quit = true | ||
| count-on-quit = true | ||
|
|
||
| # cursor-style | ||
| # change the style of your cursor. you can choose | ||
| # between a block, underscore or bar, and whether | ||
| # it is blinking. default is just whatever your | ||
| # system is already using in the terminal. | ||
| # options: default, blinking-block, steady-block, | ||
| # blinking-underscore, steady-underscore, | ||
| # blinking-bar, steady-bar | ||
| # default: cursor-style = default | ||
| cursor-style = default | ||
|
|
||
| # quit-times | ||
| # defines how many times brr will require you to | ||
| # press ctrl+q (with unsaved changes) to quit. | ||
| # note: the total number of times will be one more | ||
| # than this setting. for example, at the default | ||
| # of '2', you need to press ctrl+q a total of | ||
| # three to quit times if you have unsaved changes | ||
| # options: 0-9. 0 to disable. | ||
| # default: quit-times = 2 | ||
| quit-times = 2 | ||
|
|
||
| # save-time | ||
| # defines how many seconds of inactivity must | ||
| # elapse before brr will save your file next | ||
| # time you press a key. | ||
| # options: 0-9. 0 to disable. | ||
| # default: save-time = 5 | ||
| save-time = 5 | ||
|
|
||
| # save-words | ||
| # defines how many words you must write before | ||
| # brr saves all but the last one. for example, | ||
| # if you set it to 6, upon starting the 6th | ||
| # word, brr will save the last five. | ||
| # note: setting this to 1 disables it as well | ||
| # because otherwise brr would just try to save | ||
| # the last 0 words every 1 words written (which | ||
| # theoretically does nothing, but actually slows | ||
| # brr down). | ||
| # options: 0-9. 0 or 1 to disable. | ||
| # default: save-words = 6 | ||
| save-words = 6 | ||
|
|
||
|
|
||
| style if style.contains("default") => Some(SetCursorStyle::DefaultUserShape), | ||
| style if style.contains("blinking-block") => Some(SetCursorStyle::BlinkingBlock), | ||
| style if style.contains("steady-block") => Some(SetCursorStyle::SteadyBlock), | ||
| style if style.contains("blinking-underscore") => Some(SetCursorStyle::BlinkingUnderScore), | ||
| style if style.contains("steady-underscore") => Some(SetCursorStyle::SteadyUnderScore), | ||
| style if style.contains("blinking-bar") => Some(SetCursorStyle::BlinkingBar), | ||
| # brr config file | ||
| # this is the default config file for brr, you can | ||
| # copy it and change it to your liking, just make | ||
| # sure it's called brr.conf and in the same folder | ||
| # as brr's executable. | ||
| # start-edit | ||
| # defines if brr should start in edit mode. false | ||
| # starts brr in view mode. | ||
| # options: true, false | ||
| # default: start-edit = true | ||
| start-edit = true | ||
| # open-search | ||
| # when this is active and you open a file without | ||
| # an extension at the end, brr will automatically | ||
| # search the current working directory for a file | ||
| # matching that name in either .txt or .md format | ||
| # and open that instead. | ||
| # options: true, false | ||
| # default: open-search = true | ||
| open-search = true | ||
| # quit-word-count | ||
| # when this is active, brr will give you an | ||
| # approximate count of how many words and | ||
| # characters you wrote during the session. | ||
| # note: if you open a new file without closing | ||
| # brr, the count will only show data from the | ||
| # last file you edited. | ||
| # options: true, false | ||
| # default: count-on-quit = true | ||
| count-on-quit = true | ||
| # cursor-style | ||
| # change the style of your cursor. you can choose | ||
| # between a block, underscore or bar, and whether | ||
| # it is blinking. default is just whatever your | ||
| # system is already using in the terminal. | ||
| # options: default, blinking-block, steady-block, | ||
| # blinking-underscore, steady-underscore, | ||
| # blinking-bar, steady-bar | ||
| # default: cursor-style = default | ||
| cursor-style = default | ||
| # quit-times | ||
| # defines how many times brr will require you to | ||
| # press ctrl+q (with unsaved changes) to quit. | ||
| # note: the total number of times will be one more | ||
| # than this setting. for example, at the default | ||
| # of '2', you need to press ctrl+q a total of | ||
| # three to quit times if you have unsaved changes | ||
| # options: 0-9. 0 to disable. | ||
| # default: quit-times = 2 | ||
| quit-times = 2 | ||
| # save-time | ||
| # defines how many seconds of inactivity must | ||
| # elapse before brr will save your file next | ||
| # time you press a key. | ||
| # options: 0-9. 0 to disable. | ||
| # default: save-time = 5 | ||
| save-time = 5 | ||
| # save-words | ||
| # defines how many words you must write before | ||
| # brr saves all but the last one. for example, | ||
| # if you set it to 6, upon starting the 6th | ||
| # word, brr will save the last five. | ||
| # note: setting this to 1 disables it as well | ||
| # because otherwise brr would just try to save | ||
| # the last 0 words every 1 words written (which | ||
| # theoretically does nothing, but actually slows | ||
| # brr down). | ||
| # options: 0-9. 0 or 1 to disable. | ||
| # default: save-words = 6 | ||
| save-words = 6 | ||
| style if style.contains("default") => Some(SetCursorStyle::DefaultUserShape), | ||
| style if style.contains("blinking-block") => Some(SetCursorStyle::BlinkingBlock), | ||
| style if style.contains("steady-block") => Some(SetCursorStyle::SteadyBlock), | ||
| style if style.contains("blinking-underscore") => Some(SetCursorStyle::BlinkingUnderScore), | ||
| style if style.contains("steady-underscore") => Some(SetCursorStyle::SteadyUnderScore), | ||
| style if style.contains("blinking-bar") => Some(SetCursorStyle::BlinkingBar), | ||
| style if style.contains("steady-bar") => Some(SetCursorStyle::SteadyBar), |
Oops, something went wrong.