Commit 61f25af
authored
[repo][docs] Reorganize the repo + update the readme file (#46)
This pull request includes significant updates to the `README.md` file
and several changes to benchmark files, mainly focusing on improving
documentation and code organization.
### Documentation Enhancements:
- **README.md**: Expanded the overview and added detailed descriptions
of the `Decimal` type and future roadmap items. Enhanced the
installation instructions and added a comprehensive quick-start guide.
- **Status Section**: Updated the status of the project phases,
detailing the completion of the "Make it Work" phase, progress in the
"Make it Right" phase, and significant advancements in the "Make it
Fast" phase. Added a new "Future Extensions" section.
- **Footnotes**: Added footnotes to explain the fixed precision and
arbitrary precision types, providing context and comparisons to similar
implementations in other languages.
### Codebase organization:
- **Dedicated folder for Decimal type**: Added a dedicated `decimal`
sub-package for the `Decimal` type. Also added dedicated folders for the
tests and benches.1 parent 96b5a01 commit 61f25af
File tree
58 files changed
+445
-406
lines changed- .github/workflows
- benches/decimal
- docs
- src/decimojo
- decimal
- tests/decimal
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
58 files changed
+445
-406
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
55 | 55 | | |
56 | 56 | | |
57 | 57 | | |
58 | | - | |
| 58 | + | |
59 | 59 | | |
60 | 60 | | |
61 | | - | |
62 | 61 | | |
63 | 62 | | |
64 | 63 | | |
| |||
Large diffs are not rendered by default.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Lines changed: 2 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
73 | 73 | | |
74 | 74 | | |
75 | 75 | | |
76 | | - | |
| 76 | + | |
77 | 77 | | |
78 | 78 | | |
79 | 79 | | |
| |||
83 | 83 | | |
84 | 84 | | |
85 | 85 | | |
86 | | - | |
| 86 | + | |
87 | 87 | | |
88 | 88 | | |
89 | 89 | | |
| |||
File renamed without changes.
File renamed without changes.
File renamed without changes.
0 commit comments