HANB - Revision history

Mattf: Edited by GPT bot from irc

2025-04-06T21:43:42Z

Edited by GPT bot from irc

← Older revision		Revision as of 21:43, 6 April 2025
Line 41:		Line 41:

	# Clone the repository:		# Clone the repository:
	# <~~pre~~>		# <code>git clone https://github.com/handyc/hanb.git</code>
	# git clone https://github.com/handyc/hanb.git
	# </~~pre~~>
	#		#
	# Navigate to the directory:		# Navigate to the directory:
	# <~~pre~~>		# <code>cd hanb</code>
	# cd hanb
	# </~~pre~~>
	#		#
	# Install the dependencies:		# Install the dependencies:
	# <~~pre~~>		# <code>pip install -r requirements.txt</code>
	# pip install -r requirements.txt
	# </~~pre~~>
	#		#
	# Start the application:		# Start the application:
	# <~~pre~~>		# <code>python main.py</code>
	# python main.py
	# </~~pre~~>

	== Usage ==		== Usage ==
Line 64:		Line 56:

	* To create a new note, use the command:		* To create a new note, use the command:
	<~~pre~~>		<code>hanb create <note_name></code>
	hanb create <note_name>
	</~~pre~~>
	* To list all notes:		* To list all notes:
	<~~pre~~>		<code>hanb list</code>
	hanb list
	</~~pre~~>
	* To view a specific note:		* To view a specific note:
	<~~pre~~>		<code>hanb view <note_name></code>
	hanb view <note_name>
	</~~pre~~>

	For more advanced features and options, refer to the [[Documentation\|documentation]].		For more advanced features and options, refer to the [[Documentation\|documentation]].
Line 83:		Line 69:
	# Fork the repository.		# Fork the repository.
	# Create your feature branch:		# Create your feature branch:
	# <~~pre~~>		# <code>git checkout -b feature/AmazingFeature</code>
	# git checkout -b feature/AmazingFeature
	# </~~pre~~>
	#		#
	# Commit your changes:		# Commit your changes:
	# <~~pre~~>		# <code>git commit -m 'Add some AmazingFeature'</code>
	# git commit -m 'Add some AmazingFeature'
	# </~~pre~~>
	#		#
	# Push to the branch:		# Push to the branch:
	# <~~pre~~>		# <code>git push origin feature/AmazingFeature</code>
	# git push origin feature/AmazingFeature
	# </~~pre~~>
	#		#
	# Open a Pull Request.		# Open a Pull Request.

Mattf: Edited by GPT bot from irc

2025-04-06T21:42:07Z

Edited by GPT bot from irc

← Older revision		Revision as of 21:42, 6 April 2025
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:
	~~# '''Command''':~~
	# <pre>		# <pre>
	# git clone https://github.com/handyc/hanb.git		# git clone https://github.com/handyc/hanb.git
Line 21:		Line 46:
	#		#
	# Navigate to the directory:		# Navigate to the directory:
	~~# '''Command''':~~
	# <pre>		# <pre>
	# cd hanb		# cd hanb
Line 27:		Line 51:
	#		#
	# Install the dependencies:		# Install the dependencies:
	~~# '''Command''':~~
	# <pre>		# <pre>
	# pip install -r requirements.txt		# pip install -r requirements.txt
Line 33:		Line 56:
	#		#
	# Start the application:		# Start the application:
	~~# '''Command''':~~
	# <pre>		# <pre>
	# python main.py		# python main.py
Line 61:		Line 83:
	# Fork the repository.		# Fork the repository.
	# Create your feature branch:		# Create your feature branch:
	~~# '''Command''':~~
	# <pre>		# <pre>
	# git checkout -b feature/AmazingFeature		# git checkout -b feature/AmazingFeature
Line 67:		Line 88:
	#		#
	# Commit your changes:		# Commit your changes:
	~~# '''Command''':~~
	# <pre>		# <pre>
	# git commit -m 'Add some AmazingFeature'		# git commit -m 'Add some AmazingFeature'
Line 73:		Line 93:
	#		#
	# Push to the branch:		# Push to the branch:
	~~# '''Command''':~~
	# <pre>		# <pre>
	# git push origin feature/AmazingFeature		# git push origin feature/AmazingFeature

Mattf: Edited by GPT bot from irc

2025-04-06T21:37:07Z

Edited by GPT bot from irc

← Older revision		Revision as of 21:37, 6 April 2025
Line 14:		Line 14:
	To install HANB, follow these steps:		To install HANB, follow these steps:

	1. Clone the repository:		# Clone the repository:
	~~```bash~~		# '''Command''':
	git clone https://github.com/handyc/hanb.git		# <pre>
	~~```~~		# git clone https://github.com/handyc/hanb.git
			# </pre>
	2. Navigate to the directory:		#
	~~```bash~~		# Navigate to the directory:
	cd hanb		# '''Command''':
	~~```~~		# <pre>
			# cd hanb
	3. Install the dependencies:		# </pre>
	~~```bash~~		#
	pip install -r requirements.txt		# Install the dependencies:
	~~```~~		# '''Command''':
			# <pre>
	4. Start the application:		# pip install -r requirements.txt
	~~```bash~~		# </pre>
	python main.py		#
	~~```~~		# Start the application:
			# '''Command''':
			# <pre>
			# python main.py
			# </pre>

	== Usage ==		== Usage ==
Line 38:		Line 42:

	* To create a new note, use the command:		* To create a new note, use the command:
	~~```bash~~		<pre>
	hanb create <note_name>		hanb create <note_name>
	~~```~~		</pre>
	* To list all notes:		* To list all notes:
	~~```bash~~		<pre>
	hanb list		hanb list
	~~```~~		</pre>
	* To view a specific note:		* To view a specific note:
	~~```bash~~		<pre>
	hanb view <note_name>		hanb view <note_name>
	~~```~~		</pre>

	For more advanced features and options, refer to the [documentation]~~(https://github.com/handyc/hanb/blob/main/README.md)~~.		For more advanced features and options, refer to the [[Documentation\|documentation]].

	== Contribution ==		== Contribution ==
	Contributions are welcome! If you would like to contribute to HANB, please follow these steps:		Contributions are welcome! If you would like to contribute to HANB, please follow these steps:

	1. Fork the repository.		# Fork the repository.
	2. Create your feature branch:		# Create your feature branch:
	~~```bash~~		# '''Command''':
	git checkout -b feature/AmazingFeature		# <pre>
	~~```~~		# git checkout -b feature/AmazingFeature
	3. Commit your changes:		# </pre>
	~~```bash~~		#
	git commit -m 'Add some AmazingFeature'		# Commit your changes:
	~~```~~		# '''Command''':
	4. Push to the branch:		# <pre>
	~~```bash~~		# git commit -m 'Add some AmazingFeature'
	git push origin feature/AmazingFeature		# </pre>
	~~```~~		#
	5. Open a Pull Request.		# Push to the branch:
			# '''Command''':
			# <pre>
			# git push origin feature/AmazingFeature
			# </pre>
			#
			# Open a Pull Request.

	== License ==		== License ==
	HANB is released under the MIT License. See the [LICENSE]~~(https://github.com/handyc/hanb/blob/main/LICENSE)~~ file for details.		HANB is released under the MIT License. See the [[License\|LICENSE]] file for details.

	== References ==		== References ==

Mattf: Edited by GPT bot from irc

2025-04-06T21:35:55Z

Edited by GPT bot from irc

New page

= HANB =

== Overview ==
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 ==
* '''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.

== Installation ==
To install HANB, follow these steps:

1. Clone the repository:
```bash
git clone https://github.com/handyc/hanb.git
```

2. Navigate to the directory:
```bash
cd hanb
```

3. Install the dependencies:
```bash
pip install -r requirements.txt
```

4. Start the application:
```bash
python main.py
```

== Usage ==
To use HANB effectively, refer to the following commands and configurations:

* To create a new note, use the command:
```bash
hanb create <note_name>
```
* To list all notes:
```bash
hanb list
```
* To view a specific note:
```bash
hanb view <note_name>
```

For more advanced features and options, refer to the [documentation](https://github.com/handyc/hanb/blob/main/README.md).

== Contribution ==
Contributions are welcome! If you would like to contribute to HANB, please follow these steps:

1. Fork the repository.
2. Create your feature branch:
```bash
git checkout -b feature/AmazingFeature
```
3. Commit your changes:
```bash
git commit -m 'Add some AmazingFeature'
```
4. Push to the branch:
```bash
git push origin feature/AmazingFeature
```
5. Open a Pull Request.

== License ==
HANB is released under the MIT License. See the [LICENSE](https://github.com/handyc/hanb/blob/main/LICENSE) file for details.

== References ==
* [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.