Skip to content

Commit 19ef802

Browse files
author
alexeev-dev
committed
docs: update&improve docs
1 parent 5628fdf commit 19ef802

File tree

4 files changed

+47
-6
lines changed

4 files changed

+47
-6
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,7 @@ Check other our projects:
125125
## Project Architecture
126126

127127
```
128+
.
128129
├── build.sh
129130
├── CHANGELOG.md
130131
├── cmake
@@ -146,7 +147,6 @@ Check other our projects:
146147
├── CMakePresets.json
147148
├── CMakeUserPresets.json
148149
├── conanfile.py
149-
├── cwpLvF9U
150150
├── docs
151151
│ ├── doxygen-styles.css
152152
│ ├── en

docs/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
@mainfile
1+
@mainpage
22
# libnumerixpp
33

44
<p align="center">A Powerful C++ Library for High-Performance Numerical Computing</p>
@@ -15,15 +15,14 @@
1515
> [!CAUTION]
1616
> At the moment, libnumerixpp is under active development (alpha), many things may not work, and this version is not recommended for use (all at your own risk).
1717
18-
> [!CAUTION]
19-
> libnumerixpp in development (alpha), many things may not work, and this version is not recommended for use (all at your own risk).
20-
2118
libnumerixpp is a powerful, cross-platofrm C++ library designed for high-performance numerical computing in the domains of physics, mathematics, and computer science.
2219

2320
You can join to our [small russian telegram blog](https://t.me/hex_warehouse).
2421

2522
> You can view docs for libnumerixpp [here](https://alexeev-prog.github.io/libnumerixpp).
2623
24+
> Current version: 0.1.2
25+
2726
## Key Features
2827
- **Extensive Functionality**: libnumerixpp provides a wide range of functions coverint the core areas of mathematics, physics, and computer science, including:
2928
- Mathematics: linear algebra, calculus, geometry
@@ -127,6 +126,7 @@ Check other our projects:
127126
## Project Architecture
128127

129128
```
129+
.
130130
├── build.sh
131131
├── CHANGELOG.md
132132
├── cmake
@@ -148,7 +148,6 @@ Check other our projects:
148148
├── CMakePresets.json
149149
├── CMakeUserPresets.json
150150
├── conanfile.py
151-
├── cwpLvF9U
152151
├── docs
153152
│ ├── doxygen-styles.css
154153
│ ├── en

docs/ru/article3.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Создаем и улучшаем нашу библиотеку на C++ с CMake, тестами, документацией и блекджеком: часть 3
2+
В мире программирования создание собственных библиотек - это не просто возможность пополнения своего портфолио или способ структурировать код, а настоящий акт творческого самовыражения (и иногда велосипедостроения). Каждый разработчик иногда использовал в нескольких своих проектах однообразный код, который приходилось каждый раз перемещать. Да и хотя-бы как упаковать свои идеи и знания в удобный и доступный формат, которым можно будет поделиться с сообществом.
3+
4+
Если вы ловили себя на мысли: "А почему мне бы не создать свою полноценную библиотеку?", то я рекомендую прочитать вам мою статью.
5+
6+
Эту статью вы можете использовать как шпаргалку для создания проектов, и не только библиотек.
7+
8+
Некоторые из вас могут подумать что мы изобретаем велосипед. А я в ответ скажу - сможете ли вы прямо сейчас, без подсказок, только по памяти, нарисовать велосипед без ошибок?
9+
10+
Добро пожаловать в третью, скорее всего финальную (наверное) часть статьи! Здесь мы окончательно допишем код, исправим некоторые ошибки.
11+
12+
Первая часть доступна по [этой ссылке](https://habr.com/ru/companies/timeweb/articles/845074/), вторая часть доступна по [другой ссылке](https://habr.com/ru/companies/timeweb/articles/846736/).
13+
14+
---
15+
16+
Итак, в прошлых двух статьях мы сделали:
17+
18+
+ Автоматическую генерацию документации с ее публикацией на GitHub Pages
19+
+ Продвинутую сборку при помощи CMake
20+
+ Инструменты для форматирования и линтинга кода
21+
22+
В этой статье мы будем работать над архитектурной частью, над библиотекой, улучшим ее аспекты, и конечно-же, продолжим писать C++ код.
23+
24+
# Внешний вид библиотеки
25+
Человека встречают по одежке, а open source проект - по его описанию, README. Для того, чтобы пользователь мог понять, что к чему, следует в описании отвечать на следующие вопросы:
26+
27+
Какое назначение проекта? Описание должно быть лаконичным и отражающим суть проекта.
28+
29+
Почему проект полезен? Он должен решать определенные проблемы, поэтому необходимо явно написать о них, чтобы потенциальный пользователь мог понять, будет ли библиотека полезной для него. Нужно выделить преимущества своего решения по сравнению с аналогами, желательно с конкретными цифрами и бенчмарками, иначе потенциальный пользователь установит более эффективную или популярную библиотеку.
30+
31+
Как приступить к работе с библиотекой? Этап с установкой и настройкой библиотеки необходимо описать самым детальным образом. Ведь далеко не всегда то, что очевидно вам — очевидно другим. Решением могут пользоваться люди, у которых совершенно другой опыт. Нужно, чтобы любой желающий, кто хочет установить решение, понял, как это сделать.
32+
33+
Где можно получить дополнительную помощь, если она мне понадобится? Обязательно оставить свои контакты или другую предпочитаемую форму взаимодействия.
34+
35+
Можно использовать свой README для ответа на другие вопросы. Например, дальнейшие цели в развитии проекта, информация о лицензиях, важных изменениях в коде.
36+
37+
## Содержание
38+
39+
+ [Первая часть](https://habr.com/ru/companies/timeweb/articles/845074/)
40+
+ [Вторая часть]((https://habr.com/ru/companies/timeweb/articles/846736/)

docs/ru/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
# libnumerixpp Russian Docs
22

33
+ [Создаем свою C++ библиотеку с документацией, CMake и блекджеком](./article.md)
4+
+ [Создаем свою C++ библиотеку с документацией, CMake и блекджеком: часть 2](./article2.md)
5+
+ [Создаем свою C++ библиотеку с документацией, CMake и блекджеком: часть 3](./article3.md)

0 commit comments

Comments
 (0)