Skip to content

Commit

Permalink
root: adjusted to match the repository layout
Browse files Browse the repository at this point in the history
It appears things are a little out of place at the moment. Hence,
let's adjust it.

This patch adjusts the repository to match the current presentation.

Signed-off-by: (Holloway) Chew, Kean Ho <[email protected]>
  • Loading branch information
hollowaykeanho committed Sep 3, 2024
1 parent 4fb9d42 commit da19789
Show file tree
Hide file tree
Showing 16 changed files with 856 additions and 8 deletions.
11 changes: 3 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,7 @@ This repository facilitates
[Tom's Obvious Minimal Language](https://github.com/toml-lang/toml) operation
for all Hestia Libraries user. This library uses the character-based
streaming with low memory and low footprint (e.g.
microcontroller adata processing) considerations. Moreover, it uses the
*"everything is a string"* convention to avoid bloating the library with all
other libraries data sanitization functions. In short, HestiaTOML
**SHALL NOT AND WILL NOT** dictate when, what, and how the value is sanitized
and validated. It only makes sure the TOML syntax are correctly done and parse
from it.
microcontroller adata processing) considerations.



Expand All @@ -28,9 +23,9 @@ This project was initiated primarily because of:
2. **Friendly to low memory and low footprint environment** - using simple
string character streaming algorithm to parse the required data from TOML
syntax.
3. **Consumption freedom** - HestiaTOML makes no decision and no assumption on
3. **Consumption freedom** - HestiaTOML makes NO decision and NO assumption on
how you consume the parsed data: use the corresponding data type sanitization
function to convert from string into your desired data type.
function to convert from `string` into your desired data type, not here.
5. **Simple to integrate** - simple enough to use for all supported programming
languages.

Expand Down
35 changes: 35 additions & 0 deletions src/docs/ABSTRACTS.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
################################################################################
# NOTE #
# #
# This is a line-by-line long package descripton usually append after the #
# pitch or acting independently. You can write as long as you want as long as #
# it complies to the following rules: #
# (1) Keep it text-form only; AND #
# (2) Max 69 characters per line (DEB, RPM, and Citation requires it); #
# AND #
# (3) Keep it ASCII for backward compatibilities purposes. #
# #
# You should write the long description of the project repository like an #
# abstract: introducing, specify the problem, actions, and ends with what to #
# to exect from exploring it. #
################################################################################
# 🠳 Max #
################################################################################
Need an efficient error reporting in a memory constrained system?
Wants to keep your error messages internationalized? Having
inconsistencies for error reporting across multiple programming
languages? hestiaERROR, a component from Hestia super libraries is
here to resolve these problems.

Being as a single peaceful frontend+backend software library suite,
hestiaERROR utilizes 1-byte (8-bits) unsigned integer numbering to
represents 256 different sets of error conditions. By using
numbering system, hestiaERROR keeps the project a lot simplier and
making the error reporting isolated from language (as in English)
translations headache (compared to string type error reporting).

With its simple data type and value designations, you can
confidently operate with the highest consistencies even in the
smallest memory constraint environment (e.g. 8-bit microcontroller).

hestiaERROR - One Peaceful Frontend+Backend Software Library Suite.
78 changes: 78 additions & 0 deletions src/docs/CITATIONS.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
################################################################################
# NOTE #
# #
# This is a line-by-line citation data file is aligned to the CITATION.cff #
# file generator where it houses its specific data. You may refer to the #
# following sites for info: #
# 1. https://citation-file-format.github.io/ #
# 2. https://github.com/citation-file-format/citation-file-format #
# #
# Generally, you want to write down the following fields for appending to the #
# CITATION.cff generated by AutomataCI using the repository configurations #
# from CONFIG.toml. Among the supported fields are (and shall be rendered) as #
# follows: #
# 1. cff-version: "${PROJECT_CITATION}" #
# 2. type: "${PROJECT_CITATION_TYPE}" #
# 3. title: "${PROJECT_NAME}" #
# 4. version: "${PROJECT_VERSION}" #
# 5. date-released: "{{ Generated by Processing Release date }}" #
# 6. license: "${PROJECT_LICENSE}" #
# 7. repository: "${PROJECT_SOURCE_URL}" #
# 8. repository-code: "${PROJECT_SOURCE_URL}" #
# 9. repository-artifact: "${PROJECT_STATIC_URL}" #
# 10. url: "${PROJECT_CONTACT_WEBSITE}" #
# 11. contact: #
# - affiliation: "${PROJECT_CONTACT_NAME}" #
# email: "${PROJECT_CONTACT_EMAIL}" #
# website: "${PROJECT_CONTACT_WEBSITE}" #
# 12. abstract: >- #
# {{ Generated by Processing Abstract file }} #
# #
# #
# Hence, begin your appendix below this line. You're free to modify the #
# existing and develop from there. Some COMPULSORY fields are: #
# 1. message: >- #
# Your message here after 2 spacing from the key. Can be as long as you #
# want until then next field. #
# 2. authors: #
# - given-names: "Your Given Name" #
# name-particle: "von" #
# family-names: "Your Family Name" #
# name-suffix: "III" #
# orcid: "https://orcid.org/1234-5678-9101-1121" #
# affiliation: "Company Name OR Independent" #
# email: "[email protected]" #
# fax: "+1-2345-6788" #
# tel: "+1-2345-6789" #
# website: "https://research-project.org" #
# country: "DE" # IMPORTANT: **STRICTLY ISO3166-1 country code** #
# city: "Berlin" #
# - ... ANOTHER AUTHOR/ENTITY ... #
################################################################################
message: |-
Please cite and reference this repository accordingly.
authors:
- given-names: "Kean Ho"
family-names: "Chew"
email: "[email protected]"
affiliation: "Independent"
orcid: "https://orcid.org/0000-0003-4202-4863"
- given-names: "Cory"
family-names: "Galyna"
email: "[email protected]"
affiliation: "Independent"
identifiers:
- type: doi
value: "10.5281/zenodo.00000000"
description: "General & Latest"
keywords:
- "hestiaERROR"
- "error numbering"
- "error numbers"
- "super libraries"
- "programming languages"
- "library"
- "continuous integration"
- "native and locally available"
- "solid foundation"
- "self-improvable"
Binary file added src/docs/USER-GUIDES_en.pdf
Binary file not shown.
Loading

0 comments on commit da19789

Please sign in to comment.