Lexicalcs

A way to calculate the saturation of your text.
Contribute to us / View tags / Report a bug

About the project

Many projects lack sufficient development and preparation in the area of their environment and sometimes are not intended as such at all due to the overall complexity, time-consuming and non-adaptive nature of such a process¹.

With this project, all you have to do is run some scripts, edit the necessary data and add your own basic project plugins and you will have a fully customized project from an open source perspective, ready for a development environment not only for you but for others as well.

Built-with

Project is created and "written" with help of:

Getting started

Before asking questions, read this block because here is all the primary information on the project, which can answer your future not-yet asked questions.

Prerequisites

For usage of this project, ensure you installed Obsidian, app, for which this plugin is created and on which you'll test or use this plugin.

But, for contributing to this project, we highly recommending following those prerequisites:

• Installed Node.js on your desktop on which you will edit/setup this project;
• Installed Python if you want to contribute to the scripts of this project (in terms of .PY scripts);
• It is recommended to use GitHub CLI on your machine for better experience via working not only within this project, but this the .GIT in entirety;

[^]

Installation

Permission is granted for free use in any of your products.

If you want to use this project, there are two ways to download-and-use this project: "official" and direct, so, let's start from official path:

If you want to use this plugin, there are two ways to download-and-use this plugin: official and direct, so, let's start from official path:

1. Go to your vault's settings, and go to "Settings → Community plugins" and go to the second step;
2. Disable restricted mode, and use "Community plugins → Browse" to find this plugin: type the name of the project or just write “any as note”;
3. Use plugin, type any extension in plugin's settings, edit anything you want.

Guidelines for direct-installation way:

1. Download last tag on project's repository, for the last ZIP-tarball link provided below:
   download latest release
   • or just download the source-code through "Code → Download ZIP (or any option that you want)", and proceed to the next step;
2. Open your vault's folder, go to the subfolder "`/.obsidian/ → /plugins/" and paste contents of downloaded ZIP into this subfolder;
3. Now, you can use plugin just as if you installed it from community plugins.

Guidelines for installation of source code of this project:

1. Clone the repository with any form of app which supports Git (or CLI of this site), guide is attached:
   https://www.howtogeek.com/451360/how-to-clone-a-github-repository/
2. Open it with any suitable for you editor and feel free to customize, update and/or contribute to this project².

[^]

Usage

TODO.

[^]

Roadmap

• Create project and adapt repository template;
• Develop basic metrics calculator for TTR of lexical diversity;
  • Implement custom view to see more rich data about metrics;
• Implement more advanced variables and parameters of lexical diversity;
• Write a documentation (wiki) for the project;

[^]

Contributing

Contributions are what make open source community such an interest place to be in, so any form of contribution are greatly appreciated.

If you think that you can help this project become better but think its not so important/realizable in the current situtation or for a full contribution, use issues page, otherwise there is a guideline and policy for contributing.

If you want to contribute to this project, please, read contributioning policy and commit convention, this repository works with CLA, commits convention and on automated deployment system³.

For one-single file contributioning, use a more quicker way without forking the repository through site.

More about it in this article:

• "Working with forks" about syncing one-file fork;

[^]

License

Project thanks the Electron.js and Angular for their amazing repository scripts and entire infrastructure, which partially were imported to this repository.

Warning

For individual licensing and credits information, seek correspondive files and/or sources.

Project itself is being distributed under the MIT License — see the file for more specified information.

Note

Entirery of project's infrastructure is taken from repository template project:
https://github.com/Falcion/Patternugit.git

[^]

Contact

For any legal purposes, you can contact developer/maintainer through its email:

• Outlook email
  You can also check contact information in CODEOWNERS file within referencing our contacts.

If the developer/maintainer didn't answered, or you have other questions in nature, you can use issues page on this repository via specified templates or indirect self-written issue.

[^]

Acknowledgments

• https://shields.io/
• https://simpleicons.org/
• https://gitignore.io/
• https://gitattributes.io/
  • this generator is discontinued, use:
    https://richienb.github.io/gitattributes-generator/
• Best readme template

[^]

Footnotes

1. For this, please, read readme and keep in mind, that this is a template and if you want to, you could redefine entire structure of this file or entire repository. ↩

2. for contributing policy, see — CONTRIBUTING.md ↩

3. read the files of commiting convention policy and contributioning policy ↩