HANB: Difference between revisions
m Edited by GPT bot from irc |
m Edited by GPT bot from irc |
||
| (One intermediate revision by the same user not shown) | |||
| Line 9: | Line 9: | ||
* '''Rich Plugin Ecosystem''': Extend HANB's functionality with plugins tailored to different use cases. | * '''Rich Plugin Ecosystem''': Extend HANB's functionality with plugins tailored to different use cases. | ||
* '''Easy Synchronization''': Sync your notes across devices without hassle. | * '''Easy Synchronization''': Sync your notes across devices without hassle. | ||
* '''User-Friendly Interface''': Simple and intuitive interface designed for quick access to your notes. | * '''User -Friendly Interface''': Simple and intuitive interface designed for quick access to your notes. | ||
== Board == | |||
The basis of the HANB system is a 61-cell hexagonal board, displayed in text mode in multiple sizes with 2 different rotations: | |||
<pre> | |||
a a a a a | |||
a a a a a a | |||
a a a a a a a | |||
a a a a a a a a | |||
a a a a a a a a a | |||
a a a a a a a a | |||
a a a a a a | |||
a a a a a | |||
</pre> | |||
Each cell contains a single character from a set of 64 total characters: a-z, A-Z, 0-9, - and .. | |||
Boards can be written in a compressed form as 61-character strings, e.g.: | |||
<pre> | |||
tFZ2fD1LbWJYCkaB-feYB7wkEVjINP.-taGiY8iAef7R1noBhM-uz.Bdwgmld | |||
lmXDMBOHISwvumSev7rZtf449JmaUfPIN0EGWHK-yu782UobkdRNNhrkkDVTS | |||
acuXsBJ18dV-dXTD3pi8hDD6_bDFIQ94wi9vFNbZyCa3ZL8NNN6Bb2zVzoqRE | |||
fMTNqDeeIKrPQAqveHdY5.BZRDtHxMDlotxyR3y2Cy-5VnrnDpxX6Ssk1LRps | |||
</pre> | |||
The values of cells can be interpreted in a variety of ways, and the main purpose of cell values is to indicate the presence and type of matter contained in a cell. | |||
== Installation == | == Installation == | ||
| Line 15: | Line 41: | ||
# Clone the repository: | # Clone the repository: | ||
# <code>git clone https://github.com/handyc/hanb.git</code> | |||
# < | |||
# | # | ||
# Navigate to the directory: | # Navigate to the directory: | ||
# <code>cd hanb</code> | |||
# < | |||
# | # | ||
# Install the dependencies: | # Install the dependencies: | ||
# <code>pip install -r requirements.txt</code> | |||
# < | |||
# | # | ||
# Start the application: | # Start the application: | ||
# <code>python main.py</code> | |||
# < | |||
== Usage == | == Usage == | ||
| Line 42: | Line 56: | ||
* To create a new note, use the command: | * To create a new note, use the command: | ||
< | <code>hanb create <note_name></code> | ||
hanb create | |||
</ | |||
* To list all notes: | * To list all notes: | ||
< | <code>hanb list</code> | ||
hanb list | |||
</ | |||
* To view a specific note: | * To view a specific note: | ||
< | <code>hanb view <note_name></code> | ||
hanb view | |||
</ | |||
For more advanced features and options, refer to the [[Documentation|documentation]]. | For more advanced features and options, refer to the [[Documentation|documentation]]. | ||
| Line 61: | Line 69: | ||
# Fork the repository. | # Fork the repository. | ||
# Create your feature branch: | # Create your feature branch: | ||
# <code>git checkout -b feature/AmazingFeature</code> | |||
# < | |||
# | # | ||
# Commit your changes: | # Commit your changes: | ||
# <code>git commit -m 'Add some AmazingFeature'</code> | |||
# < | |||
# | # | ||
# Push to the branch: | # Push to the branch: | ||
# <code>git push origin feature/AmazingFeature</code> | |||
# < | |||
# | # | ||
# Open a Pull Request. | # Open a Pull Request. | ||
Latest revision as of 21:43, 6 April 2025
HANB[edit]
Overview[edit]
HANB (Highly Adaptable Notetaking Backend) is a powerful, flexible, and highly configurable backend for note-taking applications. It allows users to organize their notes efficiently and access them from anywhere, with a focus on simplicity and ease of integration.
Features[edit]
- Flexible Data Storage: Supports multiple formats for storing notes, including Markdown and plain text.
- Cross-Platform Compatibility: Works seamlessly on various operating systems, including Windows, macOS, and Linux.
- Rich Plugin Ecosystem: Extend HANB's functionality with plugins tailored to different use cases.
- Easy Synchronization: Sync your notes across devices without hassle.
- User -Friendly Interface: Simple and intuitive interface designed for quick access to your notes.
Board[edit]
The basis of the HANB system is a 61-cell hexagonal board, displayed in text mode in multiple sizes with 2 different rotations:
a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a
Each cell contains a single character from a set of 64 total characters: a-z, A-Z, 0-9, - and ..
Boards can be written in a compressed form as 61-character strings, e.g.:
tFZ2fD1LbWJYCkaB-feYB7wkEVjINP.-taGiY8iAef7R1noBhM-uz.Bdwgmld lmXDMBOHISwvumSev7rZtf449JmaUfPIN0EGWHK-yu782UobkdRNNhrkkDVTS acuXsBJ18dV-dXTD3pi8hDD6_bDFIQ94wi9vFNbZyCa3ZL8NNN6Bb2zVzoqRE fMTNqDeeIKrPQAqveHdY5.BZRDtHxMDlotxyR3y2Cy-5VnrnDpxX6Ssk1LRps
The values of cells can be interpreted in a variety of ways, and the main purpose of cell values is to indicate the presence and type of matter contained in a cell.
Installation[edit]
To install HANB, follow these steps:
- Clone the repository:
git clone https://github.com/handyc/hanb.git- Navigate to the directory:
cd hanb- Install the dependencies:
pip install -r requirements.txt- Start the application:
python main.py
Usage[edit]
To use HANB effectively, refer to the following commands and configurations:
- To create a new note, use the command:
hanb create <note_name>
- To list all notes:
hanb list
- To view a specific note:
hanb view <note_name>
For more advanced features and options, refer to the documentation.
Contribution[edit]
Contributions are welcome! If you would like to contribute to HANB, please follow these steps:
- Fork the repository.
- Create your feature branch:
git checkout -b feature/AmazingFeature- Commit your changes:
git commit -m 'Add some AmazingFeature'- Push to the branch:
git push origin feature/AmazingFeature- Open a Pull Request.
License[edit]
HANB is released under the MIT License. See the LICENSE file for details.
References[edit]
- [HANB GitHub Repository](https://github.com/handyc/hanb)
Note: This is just a basic representation of how to structure the HANB documentation. Feel free to add more specific data or modify the sections as necessary.
