Nim Lib

Personal Nim library
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Base
5. Usage
6. Usage
7. Usage
8. Usage
9. Roadmap
10. Contributing
11. License
12. Contact
13. Acknowledgments

About The Project

Cette librairie permet de centraliser tous les types de besoins génériques à une même place. Elle est découpé en plusieurs regroupement :

Section	script	description
📂 base	📄 OutilsBase.nim	Fonctions de base, petit traitement et opérations sur chaines, encryption.
📂 commun	📄 OutilsCommun.nim	Traitement et fonctions communes sur heures, date, os, fichiers, répertoires
📂 commun	📄 password_utils.nim
📂 commun	📄 utils.nim
📂 commun ➡️ load	📄	Fonctions de chargement des données de divers types (CSV, list, json, ...)
📂 commun ➡️ save	📄	Fonctions de sauvegarde des données de divers types (CSV, list, json, ...)
📂 Communication	📄	Fonctions de communications
📂 Comm. ➡️ discord	📄	communication de type discord
📂 Comm. ➡️ email	📄	communication de type email
📂 Comm. ➡️ server	📄	communication de type serveur
📂 Comm. ➡️ Joplin	📄 joplin_json_utils.nim	communication de type Joplin
📂 Comm. ➡️ Joplin	📄 joplin_utils.nim	communication de type Joplin
📂 db	📄 database_utils.nim	Fonctions de type base de données
📂 listes	📄	Fonctions de traitement de listes
📂 windows ➡️ registry	📄	(Windows) Fonctions de traitement sur clé de registre
📂 windows ➡️ wmi	📄	(Windows) Fonctions de traitement sur WMI
📂 web	📄 web_utils.nim	Fonctions de type web

(back to top)

Built With

Ces fonctions sont fait pour des projets développés en Nim. Voici la liste des modules a importer par script.

Section	script	modules
📂 base	📄 OutilsBase.nim
📂 commun	📄 OutilsCommun.nim
📂 commun	📄 password_utils.nim	md5, bcrypt, random
📂 commun	📄 utils.nim	std/times
📂 commun ➡️ load
📂 commun ➡️ save
📂 Communication
📂 Comm. ➡️ discord
📂 Comm. ➡️ email
📂 Comm. ➡️ server
📂 Comm. ➡️ Joplin	📄 joplin_json_utils.nim
📂 Comm. ➡️ Joplin	📄 joplin_utils.nim
📂 db	📄 database_utils.nim	os, logging, parsecfg, db_sqlite
📂 listes	📄 listes_utils.nim
📂 windows ➡️ registry	📄 registry_utils.nim
📂 windows ➡️ wmi	📄 wmi_utils.nim
📂 web	📄 web_utils.nim

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g
  

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Get a free API Key at https://example.com
2. Clone the repo

   git clone https://github.com/your_username_/Project-Name.git
   

3. Install NPM packages

   npm install
   

4. Enter your API in config.js

   const API_KEY = 'ENTER YOUR API';
   

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Base

Détails, spécifications spécial sur la section Base

(back to top)

Roadmap

• Add Changelog
• Add back to top links
• Add Additional Templates w/ Examples
• Add "components" document to easily copy & paste sections of the readme
• Multi-language Support
  • Chinese
  • Spanish

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GNU Public License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @your_twitter - email@example.com

Project Link: https://github.com/your_username/repo_name

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• Choose an Open Source License
• GitHub Emoji Cheat Sheet
• Malven's Flexbox Cheatsheet
• Malven's Grid Cheatsheet
• Img Shields
• GitHub Pages
• Font Awesome
• React Icons

(back to top)

https://img.shields.io/git.bcmaison.cf/forks/othneildrew/Best-README-Template.svg?style=for-the-badge