Merge: doc -> main

This commit is contained in:
PedroEdiaz
2024-10-04 00:37:52 -06:00
parent d22daff16d
commit 1997801f88
10 changed files with 33 additions and 51 deletions

View File

@@ -6,7 +6,7 @@ manigraph es un graficador interactiva de variedades que lee archivos binarios,
una variedad multidimensional y grafica esta variedad en una proyección tridimensional.
# Dependencias
Para poder compilar el proyecto hace falta los siguientes pro.
Para poder compilar el proyecto hace falta lo siguiente.
## Programas
- `cc`: Cualquier compilador de C.
- `git`: Gestor de dependencias. (Opcional)
@@ -14,6 +14,7 @@ Para poder compilar el proyecto hace falta los siguientes pro.
## Librerías
- `openGL`: A cross-platform API for rendering 2D and 3D graphics. (no incluida)
- `glew`: The OpenGL Extension Wrangler Library (no incluida)
- `glfw`: A multi-platform library for OpenGL, OpenGL ES, Vulkan, window and input.
- `cglm`: Highly Optimized 2D / 3D Graphics Math (glm) for C.
### Linux
@@ -21,28 +22,18 @@ Para compilar `glfw` en linux hacen falta las siguientes librerías según el ca
- `x11`: libXcursor-devel libXi-devel libXinerama-devel libXrandr-devel
- `wayland`: libwayland-dev libxkbcommon-dev wayland-protocols
# Codigo fuente
Para adquirir el código fuente de manigraph se puede usar git o descargar manualmente los
archivos zip.
## git via https
Usando git se necesitan ejecutar los siguientes comándos en la terminal.
# Descargas
- [git](https://git-scm.com/downloads/win)
- [MinGW](https://github.com/niXman/mingw-builds-binaries/releases)
- [glew](https://glew.sourceforge.net/)
# Clonar el código fuente
```
git clone https://gitea.adles.top/software/manigraph.git
cd manigraph
git submodule update --init --recursive
```
## zip files
Alternativamente se puede descargar el código fuente en formato zip usando las siguientes
direcciones y acomodando manualmente las carpetas de `glfw` y `cglm` en `ext/`.
- [manigraph](https://gitea.adles.top/software/manigraph/archive/main.zip)
- [glfw](https://github.com/glfw/glfw/archive/refs/heads/master.zip)
- [cglm](https://github.com/recp/cglm/archive/refs/heads/master.zip)
# Compilación
Para compilar manualmente el proyecto se puede usar `make` o ejecutar los comandos manualmente
en el código fuente de `manigraph`.
@@ -66,7 +57,7 @@ explicando el tema: [Compiling GLFW](https://www.glfw.org/docs/3.3/compile.html)
#### Windows
```
cc -fPIC -shared -D_GLFW_WIN32 -D_GLFW_BUILD_DLL ./ext/glfw/src/*.c -o glfw.dll
cc -fPIC -shared -D_GLFW_WIN32 -D_GLFW_BUILD_DLL ./ext/glfw/src/*.c -o glfw.dll -lgdi32
```
#### Linux
@@ -83,24 +74,19 @@ cc -fPIC -shared -D_GLFW_COCOA -D_GLFW_BUILD_DLL ./ext/glfw/src/*.c -o libglfw.s
### Manigraph
#### Windows
```
cc -L. -lglfw -lGL -I ext/cglm/include/ -I ext/glfw/include/ src/*.c -o manigraph.exe
cc -I ext/cglm/include/ -I ext/glfw/include/ src/*.c -o manigraph -L. -lglfw -lopengl32 -lglew32
```
#### Linux
```
cc -L. -lglfw -lGL -I ext/cglm/include/ -I ext/glfw/include/ src/*.c -o manigraph
cc -I ext/cglm/include/ -I ext/glfw/include/ src/*.c -o manigraph -L. -lglfw -lGL -lGLEW
```
#### Mac
```
cc -L. -lglfw -framework GL -I ext/cglm/include/ -I ext/glfw/include/ src/*.c -o manigraph
cc -framework GL -I ext/cglm/include/ -I ext/glfw/include/ src/*.c -o manigraph -L. -lglfw -lGLEW
```
# Ejecutar
En linux se puede ejecutar el programa sin instalar la llibreria de glfw usando:
## make
```
make run-linux
```
## manual
En linux se puede ejecutar el programa sin instalar la libreria de glfw usando:
```
LD_LIBRARY_PATH=. ./manigraph
```