📝 Apply english translation to doc

This commit is contained in:
Manuel Cillero 2024-02-26 08:30:17 +01:00
parent d50edff466
commit ad4a43fd7d

View file

@ -1,45 +1,62 @@
# ⌨️ Código
# 🔃 Dependencies
* PageTop incluye código de la versión [0.11.0](https://github.com/mehcode/config-rs/tree/0.11.0) de
[config](https://crates.io/crates/config), de [Ryan Leckey](https://crates.io/users/mehcode), por
las facilidades que ofrece frente a sus versiones más modernas para leer los ajustes de
configuración y delegar su asignación a tipos seguros según los requerimientos de cada módulo,
tema o aplicación.
PageTop is developed in the [Rust programming language](https://www.rust-lang.org/) and stands on
the shoulders of true giants, using some of the most stable and renowned libraries (*crates*) from
the [Rust ecosystem](https://lib.rs), such as:
* PageTop incorpora una versión adaptada del excelente *crate* [maud](https://crates.io/crates/maud)
de [Chris Wong](https://crates.io/users/lambda-fairy) (versión
[0.25.0](https://github.com/lambda-fairy/maud/tree/v0.25.0/maud)), para añadir sus funcionalidades
sin requerir la referencia a `maud` en el archivo `Cargo.toml` de cada proyecto.
* [Actix Web](https://actix.rs/) for web services and server management.
* [Tracing](https://github.com/tokio-rs/tracing) for the diagnostic system and structured logging.
* [Fluent templates](https://github.com/XAMPPRocky/fluent-templates) that incorporate
[Fluent](https://projectfluent.org/) for project internationalization.
* [SeaORM](https://www.sea-ql.org/SeaORM/) which employs [SQLx](https://docs.rs/sqlx/latest/sqlx/)
for database access and modeling.
* Among others, which you can review in the PageTop
[`Cargo.toml`](https://github.com/manuelcillero/pagetop/blob/main/Cargo.toml) file.
* PageTop usa los reconocidos *crates* [SQLx](https://github.com/launchbadge/sqlx) y
[SeaQuery](https://github.com/SeaQL/sea-query) para interactuar con bases de datos. Sin embargo,
para restringir las migraciones a módulos, se ha integrado en el código una versión modificada de
[SeaORM Migration](https://github.com/SeaQL/sea-orm/tree/master/sea-orm-migration) (versión
[0.12.8](https://github.com/SeaQL/sea-orm/tree/0.12.8/sea-orm-migration/src)).
# ⌨️ Code
* PageTop includes code from version [0.11.0](https://github.com/mehcode/config-rs/tree/0.11.0) of
[config](https://crates.io/crates/config) by [Ryan Leckey](https://crates.io/users/mehcode). This
inclusion provides advantages over its more modern versions for reading configuration settings and
delegating their assignment to safe types according to the requirements of each package, theme, or
application.
* PageTop incorporates an adapted version of the excellent crate
[maud](https://crates.io/crates/maud) by [Chris Wong](https://crates.io/users/lambda-fairy)
(version [0.25.0](https://github.com/lambda-fairy/maud/tree/v0.25.0/maud)), to add its
functionalities without requiring a reference to `maud` in the `Cargo.toml` file of each project.
* PageTop utilizes the renowned crates [SQLx](https://github.com/launchbadge/sqlx) and
[SeaQuery](https://github.com/SeaQL/sea-query) for database interactions. However, to restrict
migrations to packages, a modified version of
[SeaORM Migration](https://github.com/SeaQL/sea-orm/tree/master/sea-orm-migration) (version
[0.12.8](https://github.com/SeaQL/sea-orm/tree/0.12.8/sea-orm-migration/src)) has been integrated
into the code.
# 🗚 FIGfonts
PageTop utiliza el paquete [figlet-rs](https://crates.io/crates/figlet-rs) de *yuanbohan* para
mostrar en el terminal un rótulo de presentación con el nombre de la aplicación usando caracteres
[FIGlet](http://www.figlet.org). Las fuentes incluidas en `src/app` son:
PageTop uses the [figlet-rs](https://crates.io/crates/figlet-rs) package by *yuanbohan* to display a
presentation banner in the terminal with the application's name using
[FIGlet](http://www.figlet.org) characters. The fonts included in `src/app` are:
* [slant.flf](http://www.figlet.org/fontdb_example.cgi?font=slant.flf) por *Glenn Chappell*.
* [small.flf](http://www.figlet.org/fontdb_example.cgi?font=small.flf) por *Glenn Chappell*
(predeterminado).
* [speed.flf](http://www.figlet.org/fontdb_example.cgi?font=speed.flf) por *Claude Martins*.
* [starwars.flf](http://www.figlet.org/fontdb_example.cgi?font=starwars.flf) por *Ryan Youck*.
* [slant.flf](http://www.figlet.org/fontdb_example.cgi?font=slant.flf) by *Glenn Chappell*
* [small.flf](http://www.figlet.org/fontdb_example.cgi?font=small.flf) by *Glenn Chappell* (default)
* [speed.flf](http://www.figlet.org/fontdb_example.cgi?font=speed.flf) by *Claude Martins*
* [starwars.flf](http://www.figlet.org/fontdb_example.cgi?font=starwars.flf) by *Ryan Youck*
# 📰 Plantillas
# 📰 Templates
* El diseño de la página predeterminada de inicio está basado en la plantilla
[Zinc](https://themewagon.com/themes/free-bootstrap-5-html5-business-website-template-zinc) creada
por [inovatik](https://inovatik.com/) y distribuida por [ThemeWagon](https://themewagon.com).
* The default welcome homepage design is based on the
[Zinc](https://themewagon.com/themes/free-bootstrap-5-html5-business-website-template-zinc)
template created by [inovatik](https://inovatik.com/) and distributed by
[ThemeWagon](https://themewagon.com).
# 🎨 Icono
# 🎨 Icon
"La criatura" sonriente es una divertida creación de [Webalys](https://www.iconfinder.com/webalys).
Puede encontrarse en su colección [Nasty Icons](https://www.iconfinder.com/iconsets/nasty)
disponible en [ICONFINDER](https://www.iconfinder.com).
"The creature" smiling is a fun creation by [Webalys](https://www.iconfinder.com/webalys). It can be
found in their [Nasty Icons](https://www.iconfinder.com/iconsets/nasty) collection available on
[ICONFINDER](https://www.iconfinder.com).